Unkey · Schema

V2DeployGetDeploymentResponseData

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name	Type	Description
id	string	Unique deployment identifier
status	string	Current deployment status
errorMessage	string	Error message if deployment failed
hostnames	array	Hostnames associated with this deployment
steps	array	Deployment steps with status and messages

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2DeployGetDeploymentResponseData",
  "title": "V2DeployGetDeploymentResponseData",
  "type": "object",
  "required": [
    "id",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique deployment identifier",
      "example": "d_abc123xyz"
    },
    "status": {
      "type": "string",
      "description": "Current deployment status",
      "enum": [
        "UNSPECIFIED",
        "PENDING",
        "STARTING",
        "BUILDING",
        "DEPLOYING",
        "NETWORK",
        "FINALIZING",
        "READY",
        "FAILED",
        "SKIPPED",
        "AWAITING_APPROVAL",
        "STOPPED",
        "SUPERSEDED",
        "CANCELLED"
      ],
      "example": "READY",
      "x-speakeasy-unknown-values": "allow"
    },
    "errorMessage": {
      "type": "string",
      "description": "Error message if deployment failed",
      "example": "Failed to pull image: authentication required"
    },
    "hostnames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Hostnames associated with this deployment",
      "example": [
        "app.example.com",
        "api.example.com"
      ]
    },
    "steps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/V2DeployDeploymentStep"
      },
      "description": "Deployment steps with status and messages"
    }
  }
}