Health

System health check

Changed on

Check whether the API is running.

Returns ok while everything the API depends on is reachable, and degraded with a 503 status if something is not — useful for uptime monitors and status pages.

No API key needed, and it never costs credits.

get/health

Request

  • Base URL: https://api.scalelist.com
  • URL: https://api.scalelist.com/health
  • Auth: API key in header x-api-key

Response

Default Response

statusstring

Changes

  • 4863f1805423Revision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status