API reference
footprint
7 endpoints in this area. Each one has its own page with its parameters, its response and a request you can run.
| Method | Path | What it does | Permission |
|---|---|---|---|
| GET | /v1/footprint | The footprint checker for this organisation — allowances, sites and latest verdict. | — |
| GET | /v1/footprint/runs | The organisation's footprint checks, newest first. | — |
| POST | /v1/footprint/runs | Check now — start an on-demand footprint check. | — |
| GET | /v1/footprint/runs/{run_id} | One footprint check — its findings, its most linked site pairs and each site's state. | — |
| GET | /v1/footprint/runs/{run_id}/links | Every site one site is tied to in a check, and by which findings. | — |
| POST | /v1/footprint/sites | Include a site hosted elsewhere in footprint checks. | — |
| DELETE | /v1/footprint/sites/{site_id} | Stop including a site hosted elsewhere; its slot is free at once. | — |