API reference¶
The portal exposes a JSON API for programmatic site management. Same surface area as the web UI, with bearer-token auth.
Status: skeleton
Full content + OpenAPI spec lands in a follow-up pass.
Authentication¶
Admin tokens are created in the portal: Account → API tokens → New token. Tokens have site-scoped or account-scoped permissions; choose the narrowest that fits.
Base URL¶
Common endpoints¶
| Method | Path | Purpose |
|---|---|---|
GET |
/v1/sites |
List sites |
POST |
/v1/sites |
Create a site |
GET |
/v1/sites/{id} |
Get site detail |
PUT |
/v1/sites/{id}/config |
Update configuration |
POST |
/v1/sites/{id}/purge |
Purge cache for this site |
GET |
/v1/sites/{id}/metrics |
Get metrics rollup |
Rate limits¶
- 60 requests per minute per token, sliding window
429responses includeRetry-After
Idempotency¶
Mutating endpoints accept an Idempotency-Key header. Repeated requests with the same key return the same response.