There are two ways to create a website in Silktide.

This is the most basic approach, which creates the website and immediately starts testing it. In most cases, this will be all you need.

Compare this with creating a website with advanced settings.

Request

POST /v1/websites

Example request:

{
  "website": {
    "homeUrl": "<https://fake-university.com/>",
    "name": "Fake University",
    "maxPages": 100,
    "maxDocuments": 100,
    "runNow": true
  },
  "schedule": {
    "schedulePreset": "weekly"
  },
  "options": {
    "website.benchmarkId": "fortune-500-usa",
    "website.benchmarkPercentile": 90
  },
  "tagIds": [
    "pre-production"
  ],
  "metaValues": {
    "author": "Joe Bloggs",
    "region": "UK"
  }
}

homeUrl string, required

The URL of the homepage of the website.

name string, required

The name of the website.

maxPages integer, required

The maximum number of pages this website can use. This must fit within your account’s allowance.

maxDocuments integer, required

The maximum number of documents this website can use. This must fit within your account’s allowance.

schedule object