Health Check

GET /healthz

View the health of the Canister API

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • status string

      Values are 200 OK or 500 Internal Server Error.

    • date string(date-time)
    • data object
      Hide data attributes Show data attributes object
      • healthy boolean
      • service_data object
        Hide service_data attributes Show service_data attributes object
        • healthy boolean
        • typesense_healthy boolean
        • postgres_healthy boolean
      • route_data object
        Hide route_data attributes Show route_data attributes object
        • package object
          Hide package attributes Show package attributes object
          • healthy boolean
          • lookup_healthy boolean
          • multi_lookup_healthy boolean
          • search_healthy boolean
        • repository object
          Hide repository attributes Show repository attributes object
          • healthy boolean
          • lookup_healthy boolean
          • packages_healthy boolean
          • safety_healthy boolean
          • search_healthy boolean
        • download object
          Hide download attributes Show download attributes object
          • healthy boolean
          • ingest_healthy boolean
GET /healthz 
curl \
 --request GET 'http://api.example.com/healthz'
Response examples (200) 
{
  "status": "200 OK",
  "date": "2025-05-04T09:42:00Z",
  "data": {
    "healthy": true,
    "service_data": {
      "healthy": true,
      "typesense_healthy": true,
      "postgres_healthy": true
    },
    "route_data": {
      "package": {
        "healthy": true,
        "lookup_healthy": true,
        "multi_lookup_healthy": true,
        "search_healthy": true
      },
      "repository": {
        "healthy": true,
        "lookup_healthy": true,
        "packages_healthy": true,
        "safety_healthy": true,
        "search_healthy": true
      },
      "download": {
        "healthy": true,
        "ingest_healthy": true
      }
    }
  }
}