Get deployment details

GET/deployments/{id}

Get information about a deployment's status.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response

application/json

Deployment retrieved successfully

Deployment record information.

id*string

Unique identifier for the deployment

status*string

Current status of the deployment

Value in

"queued"
"in_progress"
"running"
"failed"
"stopped"

status_reason?string

Status reason

region*string

Deployment region code

entrypoint_rel_path?string

Relative path to the application entrypoint

env_vars?

Environment variables configured for this deployment. Values are redacted for API key, OAuth, and managed-auth callers, which receive every key with an empty string value. Only dashboard sessions receive the actual values.

created_at*string

Timestamp when the deployment was created

Formatdate-time

updated_at?string

Timestamp when the deployment was last updated

Formatdate-time

source_type?string

Origin of the deployed source code. This is read-only response provenance; file indicates an uploaded archive and github indicates a repository fetched by the API.

Value in

"file"
"github"

source_url?string

For GitHub-sourced deployments, the repository URL that was fetched. Omitted for file uploads.

source_ref?string

For GitHub-sourced deployments, the git ref as requested at deploy time (branch, tag, or commit SHA — not resolved to a commit). Omitted for file uploads.

source_path?string

For GitHub-sourced deployments, the subpath within the repository that was used as the deploy root. Omitted when the repo root was used or for file uploads.

source_checksum?string

Hex-encoded SHA-256 checksum of the source archive. For file uploads, this hashes the uploaded archive; for GitHub-sourced deployments, this hashes the GitHub archive downloaded by the API. Omitted for deployments created before this field was recorded.

curl -X GET "https://example.com/deployments/string"

{  "id": "string",  "status": "queued",  "status_reason": "string",  "region": "aws.us-east-1a",  "entrypoint_rel_path": "string",  "env_vars": {    "property1": "string",    "property2": "string"  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "source_type": "file",  "source_url": "string",  "source_ref": "string",  "source_path": "string",  "source_checksum": "string"}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

Get deployment details

Authorization

Path Parameters

Response