v66

OpenAPI 3.1.0raw.githubusercontent.com2026-08-0174265626.3 KB
deploy

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

Request body

deploymentIdstring required

Unique deployment identifier to retrieve

Example request

{
  "deploymentId": "d_abc123xyz"
}

Response

Deployment retrieved successfully

Example response

{
  "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
      }
    ]
  }
}