footprint

POST `/v1/footprint/sites`

Include a site hosted elsewhere in footprint checks.

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/footprint/sites \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "domain": <string> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Adds a domain that is not hosted with us. The domain is normalised to its bare host (https://www.Example.com/x becomes example.com). Refused with 422 — never silently dropped — when the external-site allowance is used up, when the domain is already included, or when it is hosted with us (and therefore already in every check).

Request body

Name	Type	Required	What it is
`domain`	`string`	Yes	A domain or URL; normalised to its bare host.
`label`	`string`	No	—

Response

Name	Type	Required	What it is
`id`	`string`	Yes	—
`domain`	`string`	Yes	The bare host.
`label`	`string`	Yes	—
`created_at`	`string`	Yes	—

Errors this endpoint can return

400 · 401 · 403 · 404 · 422

POST /v1/footprint/sites