Health

Get system health

Returns health check results for database, Redis, and other services.

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

curl -X GET "//api.ocore.dev/api/admin/health" \
  -H "Authorization: <token>"

{
  "checks": [
    {}
  ],
  "status": "string"
}

Get server version

Returns the current server version and optionally the latest available release.

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

curl -X GET "//api.ocore.dev/api/admin/version" \
  -H "Authorization: <token>"

{
  "latestRelease": {},
  "version": "string"
}

Returns public liveness status. When HEALTH_CHECK_TOKEN is configured and a matching Bearer token is supplied, returns rich operational health details; unauthenticated 200 responses are intentionally minimal.

curl -X GET "//api.ocore.dev/api/health"

{
  "status": "string"
}

Get instance health status

Runs a full health check and returns the current health status for the instance.

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID (UUID)

curl -X GET "//api.ocore.dev/api/instances/<string>/monitoring/health" \
  -H "Authorization: <token>"

{
  "checks": [
    {}
  ],
  "instanceId": "string",
  "lastCheck": "string",
  "status": "string"
}

Get instance uptime

Returns uptime percentage and incident log for the given period.

Authorization

Authorization<token>

JWT Bearer token (format: Bearer {token})

In: header

Path Parameters

idRequiredstring

Instance ID (UUID)

Query Parameters

daysinteger

Number of days (1-365)

Default: 30

curl -X GET "//api.ocore.dev/api/instances/<string>/monitoring/uptime?days=30" \
  -H "Authorization: <token>"

{}

Was this page helpful?

Health

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript

Response

TypeScript