Skip to main content
GET
/
api
/
v1
/
beam
/
{config_id}
/
deploy
/
stats
Get Deployment Status Handler
curl --request GET \
  --url https://api.allium.so/api/v1/beam/{config_id}/deploy/stats \
  --header 'X-API-KEY: <api-key>'
{
  "workers_health": {
    "total_workers": 123,
    "healthy_workers": 123,
    "unhealthy_workers": 123,
    "crashing_workers": 123,
    "oom_killed_workers": 123,
    "workers": [
      {
        "name": "<string>",
        "status": "<string>",
        "is_ready": true,
        "is_crash_looping": true,
        "is_oom_killed": true,
        "restart_count": 123,
        "start_time": "<string>"
      }
    ]
  }
}
Returns worker health information for the deployment.
Required permission: read — owners, editors, readers, and members of teams shared via viewer_team.
Path parameters:
ParameterDescription
config_idPipeline configuration ID
curl -X GET https://api.allium.so/api/v1/beam/${CONFIG_ID}/deploy/stats \
  -H "X-API-Key: ${ALLIUM_API_KEY}"
Response: 
{
  "workers_health": {
    "total_workers": 3,
    "healthy_workers": 3,
    "unhealthy_workers": 0,
    "crashing_workers": 0,
    "oom_killed_workers": 0,
    "workers": [
      {
        "name": "abc123",
        "status": "Running",
        "is_ready": true,
        "is_crash_looping": false,
        "is_oom_killed": false,
        "restart_count": 0,
        "start_time": "2025-01-15T10:30:00Z"
      }
    ]
  }
}
FieldDescription
total_workersNumber of worker pods
healthy_workersWorkers running normally
unhealthy_workersWorkers not ready
crashing_workersWorkers in crash loop
oom_killed_workersWorkers killed due to memory
restart_countHigh restart counts indicate instability

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
config_id
string
required

Response

Successful Response

​
workers_health
WorkersHealthSummary · object

Health status summary of workers in the deployment