Sign in

v14

latestOpenAPI 3.0.32026-08-04377889.4 MB
deployments

Get a deployment by ID or URL

Retrieves information for a deployment either by supplying its ID (id property) or Hostname (url property). Additional details will be included when the authenticated user or team is an owner of the deployment.

get/v13/deployments/{idOrUrl}

Path parameters

idOrUrlstring required

The unique identifier or hostname of the deployment.

Example:dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ

The unique identifier or hostname of the deployment.

Query parameters

withGitRepoInfostring

When true, the response includes the gitSource object with the commit SHA, branch name, and connected repository metadata. Defaults to false.

Example:true

When true, the response includes the gitSource object with the commit SHA, branch name, and connected repository metadata. Defaults to false.

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

Returns a reduced view of the deployment with public information only. Private fields are omitted when the requester is not the deployment owner. Returns the deployment object for the authenticated owner, including private fields such as environment variables, build log URLs, and internal metadata. Returns the reduced deployment view for anonymous (vcn_) callers. Pool-team details are withheld.

OR
OR

Example response

{
  "id": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ",
  "readyState": "READY"
}