TracePass
Get started
DPP scope check

Start a catalogue run

Triggers a fresh catalogue scope run that re-checks the whole catalogue against the current rules. The run queues immediately and executes asynchronously; the response is 202 with a `runId` to poll. The catalogue also refreshes nightly automatically.

POST/api/v1/scope/catalogue/runs
Download OpenAPI 3.1
POST/api/v1/scope/catalogue/runs

Start a catalogue run

Triggers a fresh catalogue scope run that re-checks the whole catalogue against the current rules. The run queues immediately and executes asynchronously; the response is 202 with a `runId` to poll. The catalogue also refreshes nightly automatically.

Requires Growth or higher. Idempotency-Key is honoured: reuse the same key within 24 hours to get the original run back without queueing a second one. 409 `run_in_progress` when a run for this company is already queued or running (the running `runId` is in the body). 429 `run_cooldown` with `retryAfter` if a run finished less than 10 minutes ago.

Headers

  • Authorizationrequired

    string

    `Bearer <token>` — either a `tp_` API key (Developer → API Keys; simplest, for server-to-server) or an OAuth 2.0 access token (Developer → OAuth Apps; for user-authorized apps, scoped + revocable). The Authentication page has the full OAuth flow and scope list.

    e.g. Bearer tp_REDACTED_xxxxxxxxxxxx

  • Idempotency-Key

    string

    UUID v4 per logical run request. Reuse within 24 hours to get the same run back.

Request

curl -sS -X POST https://app.tracepass.eu/api/v1/scope/catalogue/runs \
  -H "Authorization: Bearer tp_REDACTED_xxxxxxxxxxxx" \
  -H "Idempotency-Key: 7b4f1e2c-9a3d-4e5b-8c1a-2d3e4f5a6b7c"

Response

{ "runId": "6acbb533c5553f06d833479e", "status": "queued" }

Related endpoints