Record a deployment
/v1/projects/{project}/deployments in the Deployments API.
curl -X POST https://api.example.test/v1/projects/$PROJECT_ID/deployments \ -H "Authorization: Bearer $CI_TOKEN" \ -H "Idempotency-Key: $PIPELINE_RUN_ID" \ -H "Content-Type: application/json" \ -d '{ "environment_id": "e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7081", "version": "1.4.0", "status": "running", "commit_sha": "a1b2c3d4e5f60718293a4b5c6d7e8f9012345678", "branch": "main", "pipeline_url": "https://ci.example.test/runs/4821" }'Records a deployment into one of the project's environments. environment_id and version are required; the status is succeeded when left out, so a pipeline that reports after the fact sends one request, and a pipeline that reports as it goes sends running here and finishes the deployment below. started_at is now when left out and the status is past queued; finished_at is now when left out and the status is final. A succeeded deployment writes the version and its own id onto the environment. Use the pipeline's run id as the Idempotency-Key, so a retried step records nothing twice.
Answers 201 with the deployment and emits deployment.queued, deployment.started, deployment.succeeded or deployment.failed by status. A failed deployment tells the project manager and the lead developer; one that reached production tells the lead tester too.
Requires ability
The token must hold this ability, or the call is refused with 403.
Delivered to every endpoint subscribed to them once the change is made.
MCP tool
Runs the same action from an agent, behind the same ability.
Idempotent
Send the header on every call; the same key replays the original response for 24 hours.
Authorization
bearerToken A personal access token minted in the app under Account Settings, then API Tokens, sent as Authorization: Bearer zg_live_…. The token carries the abilities each endpoint lists under Requires ability and is frozen to one team, and optionally to one project, at mint time.
In: header
Path Parameters
The project, bound by the middleware.
uuidHeader Parameters
A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.
uuidRequest body
JSONWhat the request carriesRequiredapplication/json
A deployment to record: the environment, the version and how far it got, with the commit, the branch and the pipeline run when known. Recorded as succeeded unless status says otherwise; send running to open a deployment the pipeline will finish.
Responses
201Createdapplication/json
The deployment, 201.
400Bad requestIDEMPOTENCY_KEY_MISSINGapplication/json
Every write needs an Idempotency-Key header. Send a fresh UUID per distinct operation.
401UnauthorizedAUTHENTICATION_REQUIREDapplication/json
The request carries no bearer token, or one that is revoked, malformed, or minted for another environment (a zg_test_ token on production).
403ForbiddenTOKEN_MISSING_ABILITYapplication/json
The token is valid but does not carry the ability this endpoint requires; error.context.required_ability names the one to grant. An endpoint that also checks who registered a row answers FORBIDDEN with the same status, and says so in its own description.
On this endpoint: FORBIDDEN: when the token carries neither deployment:record nor ci:deploy, the holder's role does not carry deployment:record, or the token is a client guest's.
404Not foundRESOURCE_NOT_FOUNDapplication/json
An id in the path names nothing the token can see. TENANT_MISMATCH: the project sits outside the token's scope:project: allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
On this endpoint: RESOURCE_NOT_FOUND: when the environment is not one of the project's.
409ConflictIDEMPOTENCY_KEY_REUSEDapplication/json
The key was already used in the last 24 hours with a different request body.
422Validation failedVALIDATION_FAILEDapplication/json
The payload broke a rule, and error.fields maps each offending key to its messages. A refusal from the domain, such as a role code already taken or a team the caller does not own, uses the same code with error.message saying why and no fields.
On this endpoint: VALIDATION_FAILED: when environment_id or version is missing or malformed, status is not queued, running, succeeded or failed, the commit is not hex, or a date is unreadable.
425Too earlyIDEMPOTENCY_REPLAY_IN_PROGRESSapplication/json
The first request with this key is still running; retry in a few seconds and the original response is replayed.
429Too many requestsRATE_LIMITEDapplication/json
The token has spent its 300 requests a minute or 10,000 an hour; Retry-After says when the next one is accepted.
How is this guide?
Last updated on