API Reference/Deployments

Deployments

Deployments promote installed assets to an environment (staging or production) and expose a runtime endpoint.

The Deployment Object

FieldTypeDescription
idstringUnique deployment ID with prefix dep_ (e.g. dep_uti_prod_001)
installationIdstringID of the asset installation being deployed
environmentstringTarget environment: production | staging
endpointstringFully-qualified HTTPS URL where the deployed asset accepts inference requests
statusstringOne of: provisioning | healthy | degraded | stopped
replicasintegerNumber of replica pods running for this deployment
p50LatencyMsintegerMedian (P50) inference latency in milliseconds over the last hour
p99LatencyMsintegerP99 inference latency in milliseconds over the last hour
createdAtdatetimeISO 8601 UTC timestamp when the deployment was created

Endpoints

Returns all active deployments in a project.

Parameters

ParameterInTypeRequiredDescription
projectIde.g. proj_rpm_001querystringrequiredProject ID
environmente.g. productionquerystringoptionalproduction|staging

Request

curl "https://api.healthcloud.ai/v1/deployments?projectId=proj_rpm_001&environment=production" \
  -H "Authorization: Bearer hc_test_sk_demo_live_xxxxxx"

Response

Response200
{
  "data": [
    {
      "id": "dep_uti_prod_001",
      "installationId": "inst_uti_001",
      "environment": "production",
      "endpoint": "https://api.healthcloud.ai/v1/exec/dep_uti_prod_001",
      "status": "healthy",
      "p50LatencyMs": 43,
      "p99LatencyMs": 210
    }
  ]
}

Related Resources