deployments

Get a deployment by ID or URL

Changed on

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}

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v13/deployments/{idOrUrl}
  • Auth: HTTP bearer

Path parameters

idOrUrlstring required

The unique identifier or hostname of the deployment.

Example:dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ

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
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 reduced deployment view for anonymous (vcn_) callers. Pool-team details are withheld.

OR
OR

Example response

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

Changes

  • 2060b55dc517Revision changes
    • breaking

      added subschema #2 subschema #3 to the response body oneOf list for the response status

    • info

      removed subschema #2 subschema #3 from the response body oneOf list for the response status

  • 6c0e780b096eRevision changes
    • info

      added the non-success response with the status