Get deployment

INTERNAL - This endpoint is internal and may change without notice. Not recommended for production use.

Retrieves deployment information including status, error messages, and steps.

Authentication: Requires a valid root key with appropriate permissions.

POST /v2/deploy.getDeployment

Python (SDK)

Python

from unkey.py import Unkey


with Unkey(
    root_key="<YOUR_BEARER_TOKEN_HERE>",
) as unkey:

    res = unkey.internal.get_deployment(deployment_id="d_abc123xyz")

    # Handle response
    print(res)

200

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "id": "d_abc123xyz",
    "status": "READY",
    "errorMessage": "Failed to pull image: authentication required",
    "hostnames": [
      "app.example.com",
      "api.example.com"
    ],
    "steps": [
      {
        "status": "completed",
        "message": "Image pulled successfully",
        "errorMessage": "Connection timeout",
        "createdAt": 1704067200000
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Unkey uses API keys (root keys) for authentication. These keys authorize access to management operations in the API. To authenticate, include your root key in the Authorization header of each request:

Authorization: Bearer unkey_123

Root keys have specific permissions attached to them, controlling what operations they can perform. Key permissions follow a hierarchical structure with patterns like resource.resource_id.action (e.g., apis.*.create_key, apis.*.read_api). Security best practices:

• Keep root keys secure and never expose them in client-side code
• Use different root keys for different environments
• Rotate keys periodically, especially after team member departures
• Create keys with minimal necessary permissions following least privilege principle
• Monitor key usage with audit logs.

Body

application/json

deploymentId · string · required

Unique deployment identifier to retrieve

Minimum string length: 1

Pattern: ^d_[a-zA-Z0-9]+$

Example:

"d_abc123xyz"

Response

200

application/json

Deployment retrieved successfully

meta · object · required

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

Show child attributes

data · object · required

Show child attributes