deployments

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 this permission:

  • unkey:v1:<workspace_id>:projects/<project_id>/apps/<app_id>/environments/<environment_id>/deployments/<deployment_id>#read (use * for any level)
post/v2/deployments.getDeployment

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/deployments.getDeployment
  • Auth
    HTTP bearer

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",
    "isCurrent": true,
    "environment": "production",
    "app": "payments-api",
    "project": "acme",
    "git": {
      "commitSha": "9f2c1a7d3b",
      "branch": "main",
      "commitMessage": "fix: retry on 429",
      "commitTimestamp": 1704067100000,
      "author": {
        "handle": "octocat",
        "avatarUrl": "https://avatars.githubusercontent.com/u/583231"
      },
      "prNumber": 412,
      "forkRepository": "octocat/payments-api"
    },
    "docker": {
      "image": "ghcr.io/acme/api:v1.2.3",
      "resolvedImage": "ghcr.io/acme/api@sha256:3f1d9c0b7e2a4c8f5b6d1e0a9c8b7f6e5d4c3b2a1f0e9d8c7b6a5f4e3d2c1b0a"
    },
    "trigger": {
      "via": "github",
      "actor": {
        "type": "github",
        "id": "octocat"
      }
    },
    "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."
    },
    "issues": [
      {
        "type": "crash_loop",
        "time": 1704067260000,
        "message": "Your app used more memory than its limit and keeps stopping, so Unkey waits longer before each restart. Check its memory usage, or raise the limit.",
        "meta": {
          "reason": "out_of_memory",
          "exitCode": 137,
          "restartCount": 12
        }
      }
    ],
    "finishedAt": 1704067260000,
    "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
  }
}

Changes

    • info

      added the required property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property / to the response with the status