Get a website's settings

GET/v1/websites/{websiteId}

Returns one website: its details, who may do what with it, when it is retested, and its settings. Updating a website returns the same body.

The API key's user must be able to admin the website. A user who can only see it gets 403 AccessDenied; a website they cannot see at all, or that does not exist, gets 404 ModelNotFound.

options holds each setting that has been set or has a default. Settings can be added over time, so ignore any you do not recognize. website.languages is always present.

websiteId must be a whole number. Anything else currently returns 500 rather than 404.

Request

curl "https://api.eu.silktide.com/v1/websites/2" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"

Response: A website retested every five days

{
  "website": {
    "websiteId": 2,
    "name": "Example",
    "homeUrl": "https://example.com/",
    "status": "live",
    "maxPages": 1000,
    "maxDocuments": 500,
    "created": 1790216529,
    "lastTested": 1790302929,
    "propertyId": 0
  },
  "permissions": {
    "components": [
      {
        "permissionId": "Website-WebsiteRead",
        "componentType": "assignees",
        "label": "Can see website",
        "description": "Can see this website, and any sections within this website.",
        "inheritedPermissionIds": [
          "Website-WebsiteContribute",
          "Website-WebsiteTest",
          "Website-WebsiteReadAll"
        ],
        "models": []
      }
    ],
    "componentValues": {
      "Website-WebsiteRead": [
        "u:eu-12"
      ]
    },
    "fixedValues": {
      "Website-WebsiteRead": [
        "g:2"
      ]
    }
  },
  "schedule": {
    "scheduleInterval": "day",
    "schedulePeriod": 5,
    "scheduleFromDate": 1790216529,
    "schedulePreset": "",
    "isActive": true
  },
  "options": {
    "website.languages": [
      "en-US"
    ],
    "website.optionalLanguages": [],
    "website.maxConnections": 6,
    "website.timeout": 30,
    "website.pageWait": 0,
    "website.excludeQueryParams": [
      "utm_source",
      "utm_medium"
    ],
    "website.disableAnalytics": true,
    "website.enableAnimation": false,
    "website.reportLanguage": "",
    "website.passwordSet": false,
    "website.proxyPasswordSet": false
  },
  "tagIds": [
    "marketing"
  ],
  "governanceAiOptimizer": false,
  "governanceAiOptimizerAvailable": true,
  "reportLanguage": "en-US"
}

Request

Path parameters

websiteIdintegerrequiredat least 1
The website.

Response

200JSON.

websiteobjectrequired
The website.
Show 9 fieldsHide fields
- websiteIdintegerrequiredat least 1
  The website.
- namestringrequired
  Its name.
- homeUrlstringrequired
  Its home page.
- statusstringrequired
  installing while Silktide creates it, setup before it goes live, live once it is tested.
  One ofinstallingsetuplive
- maxPagesintegerrequired
  The most pages Silktide will test.
- maxDocumentsintegerrequired
  The most documents (PDFs) Silktide will test.
- createdintegerrequired
  When it was created.
- lastTestedintegerrequired
  When its last test finished. 0 if it has never been tested.
- propertyIdintegerrequired
  The Analytics property linked to the website. 0 when it has none.
permissionsobjectrequired
Who may do what with the website.
Show 3 fieldsHide fields
- componentslist of objectsrequired
  The permissions a website has.
  Show 6 fieldsHide fields
  - permissionIdstringrequired
    The permission, such as Website-WebsiteRead.
  - componentTypestringrequired
    What can be given it. assignees for users and roles.
  - labelstringrequired
    Its name.
  - descriptionstringrequiredcan be null
    What it allows. Null for some permissions.
  - inheritedPermissionIdslist of stringsrequired
    Permissions that include this one: anyone with those has this too.
  - modelslist of any JSONrequired
    Reserved. Empty for website permissions.
- componentValuesmap of list of stringsrequired
  Who was given each permission on this website directly, as assignee ids (u: users, g: roles).
- fixedValuesmap of list of stringsrequired
  Who has each permission from elsewhere, such as account-wide roles. Changed elsewhere, not here.
scheduleobjectrequired
When it is retested.
Show 5 fieldsHide fields
- scheduleIntervalstringrequired
  The unit it is retested in. Empty when it is not retested on a schedule.
  One ofsecondminutehourdayweekmonthyear
- schedulePeriodintegerrequired
  How many scheduleIntervals apart tests are.
- scheduleFromDateintegerrequired
  When the schedule counts from.
- schedulePresetstringrequired
  A named schedule (none, five-daily, weekly or monthly), or empty when the interval and period were set directly.
- isActivebooleanrequired
  Whether scheduled tests run.
optionsobjectrequired
Its settings, by name.
Show 38 fieldsHide fields
- website.allowFragmentPathsboolean
  Experimental. Crawl paths with fragments, such as hashbangs.
- website.allowedHttpCodeslist of integers
  HTTP codes to accept besides 2xx and 3xx, which are always accepted.
- website.authTypestring
  How Silktide signs in to pages that need it.
- website.benchmarkIdstring
  The Silktide Benchmark to grade against. Empty for none.
- website.benchmarkPercentileinteger
  The percentile to read from the benchmark.
- website.brokenLinkMaxRedirectsinteger
  How many redirects a link may take before it counts as broken.
- website.brokenLinkPropulsionFallbackboolean
  Confirm broken links in a real browser. Slower but more reliable.
- website.brokenLinkTimeoutinteger
  Seconds to wait before a link counts as broken.
- website.clickSelectorstring
  A CSS selector Silktide clicks on each page before testing it.
- website.disableAnalyticsboolean
  Block the website's analytics scripts while testing, so tests do not count as visits.
- website.disableFirstTimeVisitboolean
  Skip the built-in first-visit user flow, which tests pages before cookie banners are dismissed.
- website.disableLinkDiscoveryboolean
  Test only the URLs you give, and follow no links.
- website.disableScrollDownboolean
  Do not scroll each page to the bottom and back while testing.
- website.disableStealthboolean
  Let websites detect that Silktide's browser is automated.
- website.enableAnimationboolean
  Let pages animate. Silktide stops animation by default.
- website.exclude3rdPartyPluginIssuesboolean
  Ignore issues inside common third-party plugins, such as embedded maps.
- website.excludeQueryParamslist of strings
  Query parameters to remove from URLs, so pages that differ only by them count once.
- website.ignoreAutomaticSitemapsboolean
  Do not use the sitemaps Silktide finds on its own.
- website.inspectorCssstring
  CSS added to pages when they are shown in the Inspector.
- website.languageslist of stringsrequired
  Language codes, such as en-US, that every page is in. Always present.
- website.maxConnectionsinteger
  How many pages Silktide may load at once.
- website.normalizeUrlPathboolean
  Lowercase URL paths, for websites that mix case.
- website.optionalLanguageslist of strings
  Language codes a page might be in. Silktide detects them per page, which slows testing.
- website.pageWaitnumber
  Seconds to wait after a page loads before testing it.
- website.proxyHoststring
  A proxy server to test through.
- website.proxyPortinteger
  The proxy server's port.
- website.proxyPresetstring
  One of Silktide's proxies: eu-dublin, us-ohio or au-sydney. Empty for the region's own location.
- website.proxyUsernamestring
  The proxy server's username.
- website.readabilityFormulastring
  The readability formula, such as smog.
- website.readabilityThresholdnumber
  The readability score pages should stay within.
- website.reportLanguagestring
  The language AI reports about the website are written in. Empty for the account's language.
- website.timeoutinteger
  Seconds to wait for a page to load before giving up.
- website.trustPageDeclaredLanguageboolean
  Believe the language a page declares rather than detecting it.
- website.userAgentSuffixstring
  Text added to the end of Silktide's browser user agent.
- website.usernamestring
  The username Silktide signs in to pages with.
- website.aiEnabledboolean
  Whether Silktide's AI may work on this website.
- website.passwordSetbooleanrequired
  Whether a sign-in password is saved. Always present. Read-only: sending it changes nothing.
- website.proxyPasswordSetbooleanrequired
  Whether a proxy password is saved. Always present. Read-only, like website.passwordSet.
tagIdslist of stringsrequired
The ids of the tags on the whole website (section 0).
governanceAiOptimizerbooleanrequired
Whether the website holds one of the account's Governance AI optimizers.
governanceAiOptimizerAvailablebooleanrequired
Whether it could be given one now, counting one its own recent reports still hold.
reportLanguagestringrequired
The language its AI reports are written in: its own setting, or the account's when unset.

Errors

Status	Type	When
404	`ModelNotFound`	Nothing with that id exists in the account, or the API key's user cannot see it.
403	`AccessDenied`	The API key's user cannot admin this website.
401	`NotLoggedIn`	No API key was sent, or it is not a key for this region.(any operation)
429	`TooManyRequests`	Too many requests to this path in five seconds. Retry after the number of seconds in the `Retry-After` header, which `properties.retryAfter` repeats.(any operation)
503	-	Silktide is busy. Retry after the number of seconds in the `Retry-After` header.(any operation)

Every error has the same body. See Errors.

Access

Permission: Can admin this website
Plan feature: None
Edition: Silktide 4 and Silktide 5
Cost: Free
Available since: v1.0.0

Try it

Sends a real request to your account from this browser. Your key stays in this tab and goes only to the Silktide API.

Request

curl "https://api.eu.silktide.com/v1/websites/2" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"

Response: A website retested every five days

{
  "website": {
    "websiteId": 2,
    "name": "Example",
    "homeUrl": "https://example.com/",
    "status": "live",
    "maxPages": 1000,
    "maxDocuments": 500,
    "created": 1790216529,
    "lastTested": 1790302929,
    "propertyId": 0
  },
  "permissions": {
    "components": [
      {
        "permissionId": "Website-WebsiteRead",
        "componentType": "assignees",
        "label": "Can see website",
        "description": "Can see this website, and any sections within this website.",
        "inheritedPermissionIds": [
          "Website-WebsiteContribute",
          "Website-WebsiteTest",
          "Website-WebsiteReadAll"
        ],
        "models": []
      }
    ],
    "componentValues": {
      "Website-WebsiteRead": [
        "u:eu-12"
      ]
    },
    "fixedValues": {
      "Website-WebsiteRead": [
        "g:2"
      ]
    }
  },
  "schedule": {
    "scheduleInterval": "day",
    "schedulePeriod": 5,
    "scheduleFromDate": 1790216529,
    "schedulePreset": "",
    "isActive": true
  },
  "options": {
    "website.languages": [
      "en-US"
    ],
    "website.optionalLanguages": [],
    "website.maxConnections": 6,
    "website.timeout": 30,
    "website.pageWait": 0,
    "website.excludeQueryParams": [
      "utm_source",
      "utm_medium"
    ],
    "website.disableAnalytics": true,
    "website.enableAnimation": false,
    "website.reportLanguage": "",
    "website.passwordSet": false,
    "website.proxyPasswordSet": false
  },
  "tagIds": [
    "marketing"
  ],
  "governanceAiOptimizer": false,
  "governanceAiOptimizerAvailable": true,
  "reportLanguage": "en-US"
}

Try it

Sends a real request to your account from this browser. Your key stays in this tab and goes only to the Silktide API.