API reference

Register a site

Register a site so you can verify ownership and enable recurring monitoring. The response includes a verification token to add to DNS or the site's HTML.

POST/v1/sites

Request body

FieldTypeStatusDescription
root_urlstringrequiredThe site's root URL, e.g. https://www.example-clinic.com.
display_namestringoptionalA label for dashboards and reports. Defaults to the hostname.

Response

FieldTypeDescription
idstringSite id, used by verify / findings / history endpoints.
verification_statusstringunverified · pending · verified.
verification_tokenstringAdd as sift-site-verification=… in DNS TXT or a meta tag.
json
{
  "id": "site_a1b2",
  "root_url": "https://www.example-clinic.com",
  "display_name": "Example Clinic",
  "verification_status": "unverified",
  "verification_token": "abc123def456ghi789"
}

Examples

curl -s https://api.sifthealth.app/v1/sites \
  -H "Authorization: Bearer $SIFT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"root_url": "https://www.example-clinic.com", "display_name": "Example Clinic"}'

Next step

Hand the verification_token to whoever controls the domain, then call POST /v1/sites/{id}/verify once the record is live.