Skip to content
Get started

Get API health status

status.check_health() -> StatusCheckHealthResponse
GET/api/v1/status/health

status will always be ok whenever a 200 response is provided.

Clients can check response data or response status code to confirm health.

ReturnsExpand Collapse
class StatusCheckHealthResponse:

API health response

status: Literal["ok"]

Get API health status

from neptune_api_v2 import NeptuneAPIV2

client = NeptuneAPIV2()
response = client.status.check_health()
print(response.status)
{
  "status": "ok"
}
Returns Examples
{
  "status": "ok"
}