SurfacedBySurfacedBy Docs
DocumentationAPIReference

Domains

Register and inspect the domains your account tracks.

Ask an AI:Open in ChatGPTOpen in Claude

A tracked domain is the unit of subscription billing and scan scheduling. Adding a domain enrolls it into your plan's scan cadence; the return payload includes the domain_id you pass into every other endpoint on this page. Professional keys can list and inspect domains; Business keys can add and remove them.

The same domains appear in the dashboard under "Tracked domains". The Data API and the dashboard share one source of truth: a change made in either place shows up in the other on the next read.

GET
/domains
/domains

Query Parameters

cursorCursor

Opaque cursor returned by the previous page

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/domains?cursor=string" \
  -H "X-API-Key: string"

Successful Response

null

POST
/domains
/domains

Request Body

application/jsonRequired

[key: string]any

Header Parameters

X-API-KeyX-Api-Key

Idempotency-KeyIdempotency-Key

curl -X POST "https://example.com/domains" \
  -H "X-API-Key: string" \
  -H "Idempotency-Key: string" \
  -H "Content-Type: application/json" \
  -d '{}'

Successful Response

null

GET
/domains/{domain_id}
/domains/{domain_id}

Path Parameters

domain_id
Required
Domain Id

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/domains/string" \
  -H "X-API-Key: string"

Successful Response

null

DELETE
/domains/{domain_id}
/domains/{domain_id}

Path Parameters

domain_id
Required
Domain Id

Header Parameters

X-API-KeyX-Api-Key

Idempotency-KeyIdempotency-Key

curl -X DELETE "https://example.com/domains/string" \
  -H "X-API-Key: string" \
  -H "Idempotency-Key: string"

Successful Response

null