deployments

List deployments

Changed on

List deployments under the authenticated user or team. If a deployment hasn't finished uploading (is incomplete), the url property will have a value of null.

get/v7/deployments

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v7/deployments
  • Auth: HTTP bearer

Query parameters

appstring

Name of the deployment.

Example:docs
fromnumber

Gets the deployment created after this Date timestamp. (default: current time)

Example:1612948664566
limitnumber

Maximum number of deployments to list from a request.

Example:10
projectIdstring

Filter deployments from the given ID or name.

Example:QmXGTs7mvAMMC7WW5ebrM33qKG32QK3h4vmQMjmY
projectIdsstring[]

Filter deployments from the given project IDs. Cannot be used when projectId is specified.

[
  "prj_123",
  "prj_456"
]
targetstring

Filter deployments based on the environment.

Example:production
tonumber

Gets the deployment created before this Date timestamp. (default: current time)

Example:1612948664566
usersstring

Filter out deployments based on users who have created the deployment.

Example:kr1PsOIzqEL5Xg6M4VZcZosf,K4amb7K9dAt5R2vBJWF32bmY
sincenumber

Get Deployments created after this JavaScript timestamp.

Example:1540095775941
untilnumber

Get Deployments created before this JavaScript timestamp.

Example:1540095775951
statestring

Filter deployments based on their state (BUILDING, ERROR, INITIALIZING, QUEUED, READY, CANCELED, BLOCKED)

Example:BUILDING,READY
rollbackCandidateboolean

Filter deployments based on their rollback candidacy

branchstring

Filter deployments based on the branch name

shastring

Filter deployments based on the SHA

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

Example response

{
  "deployments": [
    {
      "buildingAt": 1609492210000,
      "created": 1609492210000,
      "creator": {
        "email": "example@example.com",
        "githubLogin": "johndoe",
        "gitlabLogin": "johndoe",
        "uid": "eLrCnEgbKhsHyfbiNR7E8496",
        "username": "johndoe"
      },
      "defaultRoute": "/docs",
      "deleted": 1609492210000,
      "errorCode": "BUILD_FAILED",
      "errorMessage": "The Deployment has been canceled because this project was not affected",
      "inspectorUrl": "https://vercel.com/acme/nextjs/J1hXN00qjUeoYfpEEf7dnDtpSiVq",
      "name": "docs",
      "oomReport": "out-of-memory",
      "ready": 1609492210000,
      "softDeletedByRetention": true,
      "source": "cli",
      "state": "READY",
      "target": "production",
      "type": "LAMBDAS",
      "uid": "dpl_2euZBFqxYdDMDG1jTrHFnNZ2eUVa",
      "undeleted": 1609492210000,
      "url": "docs-9jaeg38me.vercel.app"
    }
  ],
  "pagination": {
    "count": 20,
    "next": 1540095775951,
    "prev": 1540095775951
  }
}

Changes

  • 2060b55dc517Revision changes
    • warning

      added the new project enum value to the /// response property for the response status

  • bdab3c0b548aRevision changes
    • warning

      added the new 26.x enum value to the /// response property for the response status