System

Get healthcheck

Run and get the result of all checks

get/system/healthcheck

Request

Base URL
https://rudder.example.com/rudder/api/latest
Auth
API key in header X-API-Token
TypeScript
https://skmtc.dev/rudder/apis/rudder-api/docs/system/healthcheck/get.ts
A function with typed inputs. Its response is checked against the schema.

Healthcheck information

result'success' | 'error' required

Result of the request

action'getHealthcheckResult' required

The id of the action

{
  "data": [
    {
      "name": "RAM available",
      "msg": "Only 2GB of RAM left"
    }
  ]
}

No recorded changes to this operation across all 7 revisions of this API.