REST API

Programmatic access to your SiteBrief data. Integrate monitoring into your own tools, dashboards, or CI/CD pipelines.

Authentication

Generate an API key in Settings → API Keys. Pass it in every request via the X-Api-Key header.

curl https://sitebrief.net/api/v1/sites \
  -H "X-Api-Key: sbk_your_key_here"

⚠️

Warning:Keep your API key secret. Rotate it any time from Settings if compromised.

Base URL

https://sitebrief.net/api/v1

Endpoints

Method	Path	Description
GET	/sites	List all your sites
POST	/sites	Create a new site
GET	/sites/:id	Get a single site
PATCH	/sites/:id	Update site settings
DELETE	/sites/:id	Delete a site

GET /sites

Returns all your monitored sites.

curl https://sitebrief.net/api/v1/sites \
  -H "X-Api-Key: sbk_your_key_here"

{
  "sites": [
    {
      "id": "uuid",
      "name": "My Site",
      "url": "https://example.com",
      "status": "up",
      "uptime_percentage": "99.98",
      "last_checked_at": "2025-01-01T12:00:00Z",
      "ssl_expiry": "2025-06-01T00:00:00Z",
      "environment": "production",
      "check_interval_minutes": 2
    }
  ],
  "count": 1
}

POST /sites

Create a new site to monitor.

curl -X POST https://sitebrief.net/api/v1/sites \
  -H "X-Api-Key: sbk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My Client Site",
    "url": "https://example.com",
    "environment": "production",
    "check_interval_minutes": 5
  }'

Field	Type	Required	Description
name	string	Yes	Display name
url	string	Yes	Full URL to monitor
environment	string	No	production / staging / development
check_interval_minutes	number	No	Check every N minutes (set by plan: 2 for Free, 1 for Pro/Agency)
check_type	string	No	http / tcp / ping / dns (default: http)

PATCH /sites/:id

Update a site. Only provided fields are changed.

curl -X PATCH https://sitebrief.net/api/v1/sites/SITE_ID \
  -H "X-Api-Key: sbk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "check_interval_minutes": 1 }'

Updatable fields: name, url, environment, check_interval_minutes, keyword, paused_until.

DELETE /sites/:id

Permanently delete a site and all its check history. Returns 204 No Content.

curl -X DELETE https://sitebrief.net/api/v1/sites/SITE_ID \
  -H "X-Api-Key: sbk_your_key_here"

Error responses

Status	Meaning
401	Invalid or missing API key
403	Plan limit reached
404	Site not found
422	Validation error (missing required fields)
500	Server error

Rate limits

100 requests per minute per API key
Exceeding the limit returns 429 Too Many Requests