Docs · API v1
API reference
A small REST API over one workspace: list websites, checks with their latest status and incidents, read one incident, and add a website. JSON in and out, versioned under /api/v1. Nothing here can change checks, incidents or settings yet.
Authentication
Owners and admins create tokens under Settings → API tokens. A token is shown once; SiteOps keeps only its hash. Send it in the Authorization header:
curl -H "Authorization: Bearer siteops_…" https://siteops.foldnine.dev/api/v1/websites
- A token reads and writes only the workspace it was created in.
- It stops working when it is revoked, or when the person who created it is no longer a member of the workspace.
- A missing, malformed, unknown or revoked token gets 401.
Limits and errors
- 120 requests a minute per token, and 300 a minute per IP address. Over the limit:
429withRetry-After. - Adding websites shares the app’s limits: 30 an hour per workspace, and the plan’s website limit (5 on Free, 30 on Studio, 100 on Agency; 50 for workspaces from the beta).
- Errors are JSON:
{ "error": "…", "details": { "field": "…" } }. Status codes: 400 invalid input, 401 token, 404 not found (also for another workspace’s ids), 409 already monitored, 413/415 body, 422 address refused or plan limit reached, 429 rate limit. - Times are ISO 8601 in UTC. Ids are UUIDs.
Endpoints
GET/api/v1/websites
Every website in the workspace. health is the worst latest status among its enabled checks: up, degraded, down, pending (no result yet) or paused.
{
"data": [
{ "id": "6f1c…", "name": "Shop", "url": "https://shop.example", "client": "Acme",
"paused": false, "health": "up", "checkCount": 3, "sampleData": false,
"createdAt": "2026-10-01T09:00:00.000Z" }
]
}POST/api/v1/websites
Adds a website with the default checks (homepage, certificate for https, DNS), exactly like Add website in the app: the address must be public (no private, loopback or internal targets) on port 80, 443, 8080 or 8443. The checks are queued to run right away. Answers 201 with the website and its checks.
curl -X POST https://siteops.foldnine.dev/api/v1/websites \
-H "Authorization: Bearer siteops_…" \
-H "Content-Type: application/json" \
-d '{ "name": "Shop", "url": "shop.example", "client": "Acme" }'name (1-80 characters) and url are required; https:// is assumed when no scheme is given. client is optional.
GET/api/v1/checks
Checks with their latest status (up, degraded, down, error = could not run, or null before the first run). Optional ?websiteId=. Check evidence and configuration are not included.
{
"data": [
{ "id": "…", "websiteId": "…", "type": "http", "name": "Homepage", "enabled": true,
"intervalSeconds": 300, "failureThreshold": 2,
"latest": { "status": "up", "checkedAt": "…", "lastSuccessAt": "…", "consecutiveFailures": 0 } }
]
}GET/api/v1/incidents
Incidents, newest first. Query: state = open, acknowledged, resolved or active (open or acknowledged); websiteId; limit 1-100 (default 50); page (from 1).
curl -H "Authorization: Bearer siteops_…" "https://siteops.foldnine.dev/api/v1/incidents?state=active"
{
"data": [
{ "id": "…", "number": 12, "title": "Website unavailable — Shop", "severity": "critical",
"state": "open", "website": { "id": "…", "name": "Shop", "url": "https://shop.example" },
"check": { "id": "…", "name": "Homepage", "type": "http" },
"firstDetectedAt": "…", "lastObservedAt": "…", "acknowledgedAt": null, "resolvedAt": null,
"resolution": null, "failureCount": 2, "sampleData": false }
],
"page": 1, "limit": 50, "total": 1
}GET/api/v1/incidents/{id}
One incident, as in the list, plus its timeline (kind, message, at): opened, observed, escalated, acknowledged, notes and resolution. Possible causes are not included; they are on the incident page, marked unverified.
Exports
For a one-off copy of your data there is no need for a token: Settings → Export downloads websites, checks and incidents as CSV, or the whole workspace as JSON (owners and admins), and Reports → Download CSV gives the uptime table of the report on screen.