Health

Key Health

Check the health of the key

Checks:

• If key based logging is configured correctly - sends a test log

Usage

Pass the key in the request header

curl -X POST "http://localhost:4000/key/health"      -H "Authorization: Bearer sk-1234"      -H "Content-Type: application/json"

Response when logging callbacks are setup correctly:

{
  "key": "healthy",
  "logging_callbacks": {
    "callbacks": [
      "gcs_bucket"
    ],
    "status": "healthy",
    "details": "No logger exceptions triggered, system is healthy. Manually check if logs were sent to ['gcs_bucket']"
  }
}

Response when logging callbacks are not setup correctly:

{
  "key": "unhealthy",
  "logging_callbacks": {
    "callbacks": [
      "gcs_bucket"
    ],
    "status": "unhealthy",
    "details": "Logger exceptions triggered, system is unhealthy: Failed to load vertex credentials. Check to see if credentials containing partial/invalid information."
  }
}

POST/key/health

Authorization

APIKeyHeaderAPIKeyHeaderAPIKeyHeaderAPIKeyHeader

Response

200

Successful Response

Body

application/json

keyKey

healthyunhealthy

logging_callbacksany of

LoggingCallbackStatusnull

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/key/health', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200

{
  "key": "healthy",
  "logging_callbacks": {
    "callbacks": [
      "text"
    ],
    "status": "healthy",
    "details": "text"
  }
}