footprint

POST `/v1/footprint/runs`

Check now — start an on-demand footprint check.

Аутентификација

Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.

Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

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

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли

Детаљи

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.

Тело захтева

Назив	Тип	Обавезно	Шта је ово
`scope`	`string<account, group>`	Не	—
`group_id`	`string`	Не	Required when `scope` is `group`.

Одговор

Назив	Тип	Обавезно	Шта је ово
`run`	`FootprintRunSummary`	Да	—
`already_running`	`boolean`	Да	—

Грешке које ова крајња тачка може вратити

400 · 401 · 403 · 404 · 422 · 503

POST /v1/footprint/runs