v14

latestOpenAPI 3.0.32026-08-04377889.4 MB

deployments

List deployments

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

Query parameters

appstring

Name of the deployment.

Example:docs

Name of the deployment.

fromnumber

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

Example:1612948664566

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

limitnumber

Maximum number of deployments to list from a request.

Example:10

Maximum number of deployments to list from a request.

projectIdstring

Filter deployments from the given ID or name.

Example:QmXGTs7mvAMMC7WW5ebrM33qKG32QK3h4vmQMjmY

Filter deployments from the given ID or name.

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

Filter deployments based on the environment.

tonumber

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

Example:1612948664566

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

usersstring

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

Example:kr1PsOIzqEL5Xg6M4VZcZosf,K4amb7K9dAt5R2vBJWF32bmY

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

sincenumber

Get Deployments created after this JavaScript timestamp.

Example:1540095775941

Get Deployments created after this JavaScript timestamp.

untilnumber

Get Deployments created before this JavaScript timestamp.

Example:1540095775951

Get Deployments created before this JavaScript timestamp.

statestring

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

Example:BUILDING,READY

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

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

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