SurfacedBySurfacedBy Docs
DocumentationConsoleReference

Domains

Register the domains you scan with the Console API so keyword and platform defaults follow them across runs.

Ask an AI:Open in ChatGPTOpen in Claude

Console-managed domains are separate from dashboard-tracked domains. A Console domain is a lightweight record that stores default keywords and platforms for a target site, so you can reuse them on every scan submission without repeating yourself in the request body. The domain_id returned here is what you pass to POST /scans later.

Creation and deletion are both available on any Console account; there is no tier gate on the Console API.

GET
/domains
/domains

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/domains" \
  -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