#Health
The Health endpoint reports the operational status of the Transcodely API and its components (database, storage, queue). Use it for uptime monitoring, load balancer health checks, and integration testing.
Base path: transcodely.v1.HealthService Does not require authentication or X-Organization-ID header.
#Check health
Check the health of the API and its components.
POST /transcodely.v1.HealthService/Check
#Parameters
| Parameter | Type | Required | Description |
|---|
service | string | No | Check a specific component (e.g., database, storage, queue). Omit to check all. |
#Returns
| Field | Type | Description |
|---|
status | string | Overall status: healthy, degraded, or unhealthy. |
version | string | API server version (e.g., 1.2.0). |
components | ComponentHealth[] | Individual component statuses. |
#ComponentHealth
| Field | Type | Description |
|---|
name | string | Component name (e.g., database, storage, queue). |
status | string | Component status: healthy, degraded, or unhealthy. |
message | string | Additional details. Omitted when healthy. |
#Statuses
| Status | Description |
|---|
healthy | Fully operational. |
degraded | Operational but experiencing issues (e.g., elevated latency). |
unhealthy | Not operational. Requests may fail. |
#Example: Check all components
curl -X POST https://api.transcodely.com/transcodely.v1.HealthService/Check
-H "Content-Type: application/json"
-d '{}'
{
"status": "healthy",
"version": "1.2.0",
"components": [
{
"name": "database",
"status": "healthy"
},
{
"name": "storage",
"status": "healthy"
},
{
"name": "queue",
"status": "healthy"
}
]
}
#Example: Check a specific component
curl -X POST https://api.transcodely.com/transcodely.v1.HealthService/Check
-H "Content-Type: application/json"
-d '{"service": "database"}'
{
"status": "healthy",
"version": "1.2.0",
"components": [
{
"name": "database",
"status": "healthy"
}
]
}
#Example: Degraded response
{
"status": "degraded",
"version": "1.2.0",
"components": [
{
"name": "database",
"status": "healthy"
},
{
"name": "storage",
"status": "degraded",
"message": "Elevated latency on GCS operations"
},
{
"name": "queue",
"status": "healthy"
}
]
}
#Example: Unhealthy response
{
"status": "unhealthy",
"version": "1.2.0",
"components": [
{
"name": "database",
"status": "unhealthy",
"message": "Connection pool exhausted"
},
{
"name": "storage",
"status": "healthy"
},
{
"name": "queue",
"status": "healthy"
}
]
}
#Usage notes
- No authentication required. Load balancers and external monitoring tools can call this endpoint without API keys.
- A
degraded status means the API is functional but some operations may be slower or have higher error rates. - An
unhealthy status indicates the API cannot reliably serve requests. - For automated monitoring, check the top-level
status field. Only inspect individual components when debugging.