Sign in
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

Whether to add in gitRepo information.

Example:true

Whether to add in gitRepo information.

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

The deployment including only public information The deployment including both public and private information

OR

Example response

{
  "alias": [],
  "aliasAssigned": true,
  "creator": {
    "uid": "96SnxkFiMyVKsK3pnoHfx3Hz",
    "username": "john-doe"
  },
  "userAliases": [
    "sub1.example.com",
    "sub2.example.com"
  ],
  "id": "dpl_89qyp1cskzkLrVicDaZoDbjyHuDJ",
  "createdAt": 1540257589405,
  "readyState": "READY",
  "name": "my-project",
  "deletedAt": 1540257589405,
  "regions": [
    "sfo1"
  ],
  "source": "cli",
  "undeletedAt": 1540257589405,
  "url": "my-instant-deployment-3ij3cxz9qr.now.sh",
  "userConfiguredDeploymentId": "abc123",
  "version": 2
}

Changes