POST /v1/footprint/runs

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/runs \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

Starts a check of every site (scope: account, the default) or of one site group's hosted sites (scope: group). It counts against the month's on-demand checks; a check that could read none of its sites is not counted. If a check is already running for the organisation it is returned instead (already_running: true) and nothing is counted. The check runs in the background: poll GET /v1/footprint/runs/{run_id} until its state is done.

Request body

Response

Errors this endpoint can return

400 · 401 · 403 · 404 · 422 · 503