Get a deployment
/v1/deployments/{deployment} in the Deployments API.
curl https://api.example.test/v1/deployments/$DEPLOYMENT_ID \ -H "Authorization: Bearer $TOKEN"One deployment with its environment's name.
statusrunsqueued,running,succeeded,failed,rolled_backandcancelled; the first two are open, the rest final.sourceiscifor a pipeline's report,githubfor the host's deployment events,manualfor a person's record androllbackfor a rollback.duration_secondsis the time fromstarted_attofinished_at, null while the deployment is open.
Requires ability
The token must hold this ability, or the call is refused with 403.
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 deployment, bound by the middleware.
uuidResponses
200OKapplication/json
The deployment with its environment.
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 role does not carry deployment:view, 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 deployment is hidden from the token or missing.
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