REST API and tokens

The REST API uses JSON over HTTPS. Create a token in Settings, then API tokens, and send it as a bearer token.

Trigger a run

POST /v1/pipelines/{id}/runs
Authorization: Bearer $TOKEN

{ "branch": "main" }

POST /v1/pipelines/{id}/runs
Authorization: Bearer $TOKEN

{ "branch": "main" }

POST /v1/pipelines/{id}/runs
Authorization: Bearer $TOKEN

{ "branch": "main" }

Read a run

GET /v1/runs/{id}

GET /v1/runs/{id}

GET /v1/runs/{id}

Rate limits

Each token can make 600 requests a minute. A response with status 429 includes a retry-after header.