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
Example request
{
"deploymentId": "proj_1234abcd"
}Response
Successfully retrieved the deployment.
Example response
{
"meta": {
"requestId": "req_123"
},
"data": {
"id": "d_1234abcd",
"status": "ready",
"isCurrent": true,
"environment": "production",
"app": "payments-api",
"project": "acme",
"git": {
"commitSha": "9f2c1a7d3b",
"branch": "main"
},
"docker": {
"image": "ghcr.io/acme/api:v1.2.3"
},
"availableActions": [
"stop"
],
"regions": [
"us-east-1",
"eu-west-1"
],
"error": {
"code": "no_schedulable_regions",
"step": "deploying",
"message": "No schedulable regions configured. Please configure at least one schedulable region before deploying."
},
"domains": [
"kebap-app.unkey.app"
],
"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
}
}