Sign in
deployments

Get deployment

Retrieve a single deployment by its id.

Use this to check a deployment's status after creating it, or to inspect the runtime configuration of an existing deployment.

Required Permissions

Your root key must have one of the following permissions:

  • environment.*.read_deployment (to read deployments in any environment)
  • environment.<environment_id>.read_deployment (to read deployments in a specific environment)
post/v2/deployments.getDeployment

Request body

deploymentIdstring required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Example request

{
  "deploymentId": "proj_1234abcd"
}

Response

Successfully retrieved the deployment.

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "id": "d_1234abcd",
    "status": "ready",
    "runtime": {
      "vCpus": 0.25,
      "memoryMib": 256,
      "port": 8080,
      "command": [
        "node",
        "server.js"
      ],
      "shutdownSignal": "SIGTERM",
      "upstreamProtocol": "http1",
      "healthcheck": {
        "method": "GET",
        "path": "/healthz",
        "intervalSeconds": 10,
        "timeoutSeconds": 2,
        "failureThreshold": 3,
        "initialDelaySeconds": 5
      }
    },
    "createdAt": 1704067200000,
    "updatedAt": 1704153600000
  }
}

Changes