Database Health Check
/v1/graphs/{graph_id}/healthPart of Graph Health.
Authentication
Authenticate in any one of these ways — not all of them:
- API key in the
X-API-Keyheader. - Bearer token in the
Authorizationheader.
Path parameters
| Name | Type | Description |
|---|---|---|
graph_idrequired | string | Graph Id |
Example request
curl -X GET "https://api.robosystems.ai/v1/graphs/{graph_id}/health" \
-H "X-API-Key: $ROBOSYSTEMS_API_KEY"Responses
200 Successful Response
| Field | Type | Description |
|---|---|---|
graph_idrequired | string | Graph database identifier |
statusrequired | string | Overall health status |
connection_statusrequired | string | Database connection status |
uptime_secondsrequired | number | Database uptime in seconds |
last_query_timeoptional | string | Timestamp of last query execution |
query_count_24hrequired | integer | Number of queries executed in last 24 hours |
avg_query_time_msrequired | number | Average query execution time in milliseconds |
error_rate_24hrequired | number | Error rate in last 24 hours (percentage) |
memory_usage_mboptional | number | Instance memory in use, MB. Only populated for dedicated single-tenant instances; null on shared repositories and packed tiers. |
memory_usage_percentoptional | number | Instance memory in use, percent. Expect high values during materialization — the engine deliberately boosts to near the whole instance while rebuilding. Read `resource_status` rather than this number alone. Dedicated instances only. |
cpu_usage_percentoptional | number | Instance CPU in use, percent. Dedicated single-tenant instances only. |
resource_statusoptional | string | Interpreted instance load: 'idle' (headroom), 'busy' (working normally — typical while materializing), 'constrained' (sustained pressure worth acting on). Null when resource metrics are not exposed. |
storage_usage_mboptional | number | Storage usage in MB |
alertsoptional | string[] | Active alerts or warnings |
is_staleoptional | boolean | Whether the graph has staged changes not yet materialized Default: |
stale_reasonoptional | string | Reason the graph was marked stale (e.g. 'file_deleted: data.parquet') |
stale_sinceoptional | string | ISO timestamp when the graph became stale |
last_materialized_atoptional | string | ISO timestamp of the last successful materialization |
hours_since_materializationoptional | number | Hours elapsed since last materialization |
| Status | Meaning |
|---|---|
| 400 | Invalid request |
| 401 | Authentication required |
| 403 | Access denied |
| 404 | Resource not found |
| 422 | Validation Error |
| 429 | Rate limit exceeded |
| 500 | Internal server error |