Skip to main content
GET
/
service
/
v2
/
health
Get Service Health
curl --request GET \
  --url https://oathnet.org/api/service/v2/health \
  --header 'x-api-key: <api-key>'
{
  "status": "<string>",
  "dependencies": {
    "elasticsearch": {
      "status": "<string>",
      "error": "<string>"
    },
    "redis": {
      "status": "<string>",
      "error": "<string>"
    },
    "s3": {
      "status": "<string>",
      "error": "<string>"
    }
  },
  "checked_at_utc": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.oathnet.org/llms.txt

Use this file to discover all available pages before exploring further.

Dependency health endpoint for the service, Redis, storage, and search backend.
This endpoint returns raw JSON with dependency status details.

Authorizations

​
x-api-key
string
header
required

API key for authentication (lowercase header name)

Response

Raw health payload

​
status
string
​
dependencies
object
​
checked_at_utc
string<date-time>