Browse the API reference

Database Health Check

get/v1/graphs/{graph_id}/health

Part of Graph Health.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
graph_idrequiredstringGraph Id

Example request

curl
curl -X GET "https://api.robosystems.ai/v1/graphs/{graph_id}/health" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY"

Responses

200 Successful Response

FieldTypeDescription
graph_idrequiredstring

Graph database identifier

statusrequiredstring

Overall health status

connection_statusrequiredstring

Database connection status

uptime_secondsrequirednumber

Database uptime in seconds

last_query_timeoptionalstring

Timestamp of last query execution

query_count_24hrequiredinteger

Number of queries executed in last 24 hours

avg_query_time_msrequirednumber

Average query execution time in milliseconds

error_rate_24hrequirednumber

Error rate in last 24 hours (percentage)

memory_usage_mboptionalnumber

Instance memory in use, MB. Only populated for dedicated single-tenant instances; null on shared repositories and packed tiers.

memory_usage_percentoptionalnumber

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_percentoptionalnumber

Instance CPU in use, percent. Dedicated single-tenant instances only.

resource_statusoptionalstring

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_mboptionalnumber

Storage usage in MB

alertsoptionalstring[]

Active alerts or warnings

is_staleoptionalboolean

Whether the graph has staged changes not yet materialized

Default: false

stale_reasonoptionalstring

Reason the graph was marked stale (e.g. 'file_deleted: data.parquet')

stale_sinceoptionalstring

ISO timestamp when the graph became stale

last_materialized_atoptionalstring

ISO timestamp of the last successful materialization

hours_since_materializationoptionalnumber

Hours elapsed since last materialization

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
422Validation Error
429Rate limit exceeded
500Internal server error