API reference

/v1/sites

25 operations

← All groups

MethodPathSummaryAuth
GET/v1/sitesList websites visible in the authenticated scopeSession
POST/v1/sitesCreate a websiteSession
POST/v1/sites/batch-actionEnable, disable, soft-delete, or queue CNAME regeneration for websitesSession
GET/v1/sites/exportExport an immutable snapshot of site domainsSession
GET/v1/sites/{id}Get one website and its basic settingsSession
PATCH/v1/sites/{id}Replace the complete basic or origin settings sectionSession
DELETE/v1/sites/{id}Soft-delete a websiteSession
POST/v1/sites/{id}/lockLock a website against tenant writesSession
POST/v1/sites/{id}/origin-failbackSwitch the pool back to the highest healthy level (manual failback)Session
GET/v1/sites/{id}/origin-routingGet the normalized conditional origin-routing documentSession
PUT/v1/sites/{id}/origin-routingReplace the complete conditional origin-routing documentSession
GET/v1/sites/{id}/origin-statusOrigin pool probe state and the active origin levelSession
GET/v1/sites/{id}/schedule302Get the site's HTTP 302 scheduling settingsSession
PUT/v1/sites/{id}/schedule302Replace the site's HTTP 302 scheduling settingsSession
POST/v1/sites/{id}/unlockRestore tenant write access to a websiteSession
GET/v1/sites/{site_id}/accessGet a site's request handling settingsSession
PUT/v1/sites/{site_id}/accessReplace a site's request handling settingsSession
GET/v1/sites/{site_id}/certificate-bindingGet the active certificate binding for one siteSession
POST/v1/sites/{site_id}/dns-reconcile/applyPersist and enqueue a DNS reconciliation taskSession
POST/v1/sites/{site_id}/dns-reconcile/dry-runBuild a deterministic repair plan without provider side effectsSession
GET/v1/sites/{site_id}/dns-reconcile/tasks/{task_id}Read one durable DNS reconciliation taskSession
POST/v1/sites/{site_id}/dns-reconcile/tasks/{task_id}/cancelPersist a cancellation request for a DNS reconciliation taskSession
POST/v1/sites/{site_id}/dns-reconcile/tasks/{task_id}/commitDelete superseded records after propagation is healthySession
GET/v1/sites/{site_id}/traffic-limitRead a website's traffic caps and their enforcement (sites.read)Session
PUT/v1/sites/{site_id}/traffic-limitReplace a website's traffic caps (sites.manage)Session

Contract file:api/openapi/v1/sites.yaml api/control-site-access.openapi.yaml api/control-certificate-assets.openapi.yaml api/control-dns-reconcile.openapi.yaml api/control-site-traffic-limit.openapi.yaml