Choreo · Schema

Choreo Deployment

A deployment of a built component artifact to a target environment on the Choreo platform.

AI AppsAPI ManagementCI/CDCloud NativeDevOpsDeveloper PortalFinOpsIDEInternal Developer PlatformKubernetesLifecycleObservabilityOrchestrationPlatform EngineeringPro-Code API CompositionUnifiedWSO2Workflows

Properties

Name Type Description
id string Unique identifier for the deployment.
componentId string Component identifier being deployed.
buildId string Build identifier being deployed.
environmentId string Target environment identifier.
status string Current status of the deployment.
createdAt string Timestamp when the deployment was created.
View JSON Schema on GitHub

JSON Schema

choreo-deployment.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/choreo/refs/heads/main/json-schema/choreo-deployment.json",
  "title": "Choreo Deployment",
  "description": "A deployment of a built component artifact to a target environment on the Choreo platform.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the deployment."
    },
    "componentId": {
      "type": "string",
      "description": "Component identifier being deployed."
    },
    "buildId": {
      "type": "string",
      "description": "Build identifier being deployed."
    },
    "environmentId": {
      "type": "string",
      "description": "Target environment identifier."
    },
    "status": {
      "type": "string",
      "enum": ["Pending", "Active", "Failed", "Inactive"],
      "description": "Current status of the deployment."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the deployment was created."
    }
  },
  "required": ["id", "buildId", "environmentId", "status"]
}