Health Check - OathNet API

GET

service

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"
}

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

Show child attributes

checked_at_utc

string<date-time>

Get Scanner Quota

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"
}