BuildPusher

API reference

The platform's public API. Account and Deployer API v1 endpoints take an API token (Account → API tokens) as a bearer token, limited to the token's account and scopes. Monitoring ingest takes an environment's ingest key; heartbeat and queue endpoints take the monitor's own key; the analytics tracker posts without credentials.

OpenAPI description (JSON) · Create tokens under Account → API tokens.

Account
Request	What it does	Scope
GET /api/v1/account	The token's account	account:read

Analytics
Request	What it does	Scope
GET /api/v1/analytics/sites	Analytics sites the token can read	analytics:read
GET /api/v1/analytics/sites/{site}/report	A site's report as numbers	analytics:read
OPTIONS /api/v1/collect/{publicId}	CORS preflight for the tracker	—
POST /api/v1/collect/{publicId}	Pageviews and events from the tracker (/tracker/v1.js)	—

Deploy
Request	What it does	Scope
GET /api/v1/me	The token's person and account, with the Deploy plan	deploy:read
GET /api/v1/projects	Projects the person may deploy	deploy:read
GET /api/v1/projects/{project}	One project with its environments	deploy:read
GET /api/v1/deployments	Deployments, newest first	deploy:read
GET /api/v1/deployments/{build}	One deployment	deploy:read
GET /api/v1/deployments/{build}/log	A deployment's log	deploy:read
POST /api/v1/deployments/{build}/rollback	Make a retained release live again	deploy:write
POST /api/v1/deployments/{build}/promote	Promote a succeeded deployment to a later environment	deploy:write
POST /api/v1/environments/{environment}/deploy	Deploy the environment's repository	deploy:write
PATCH /api/v1/environments/{environment}/scale	Set how many worker replicas run	deploy:write
PATCH /api/v1/environments/{environment}/runtime	Hibernate the environment or wake it	deploy:write
PUT /api/v1/environments/{environment}/variables	Replace the environment's variables from .env text	deploy:write
PUT /api/v1/projects/{project}/workflow	Apply a version 1 workflow document	deploy:write
POST /api/v1/projects/{project}/configuration/plan	Plan a configuration document without changing anything	deploy:write
POST /api/v1/projects/{project}/configuration/reviews	Freeze a plan for 15 minutes as a review	deploy:write
POST /api/v1/projects/{project}/configuration/reviews/{review}/apply	Apply a review	deploy:write
GET /api/v1/projects/{project}/configuration/applications/{application}	An application receipt and its operations	deploy:read
POST /api/v1/projects/{project}/configuration/applications/{application}/operations/{operation}/{action}	Cancel or retry an operation	deploy:write

Monitoring
Request	What it does	Scope
POST /api/v1/deployments	Record a deployment on an environment's Monitoring timeline	—
POST /api/v1/ingest	Send a batch of telemetry events	—
GET /api/v1/ingest/receipts/{receipt}	How a batch was processed	—
POST /api/v1/otlp/v1/{signal}	OpenTelemetry (OTLP/HTTP JSON) traces, logs or metrics	—
POST /api/v1/heartbeats/{heartbeat}	A scheduled job's start, success or failure	—
POST /api/v1/queues/{queue}/snapshots	A queue's sizes at a moment	—
POST /api/v1/queues/{queue}/workers	A worker's state	—

Webhooks
Request	What it does	Scope
POST /api/repositories/{repository}/webhook	Push and pull-request webhooks from GitHub, GitLab or Bitbucket	—
POST /api/github-app/webhook	The GitHub App's webhook	—