Health checks

Check whether the SQUAKE API is reachable and healthy. The health endpoints need no API key.

SQUAKE offers three health endpoints. They're the only endpoints that work without an API key, so you can use them to test your connection before you set up authentication.

EndpointWhat it checks
GET /v2/healthzThe SQUAKE server can be reached.
GET /v2/livezThe server can be reached and its most critical dependencies, such as databases, work.
GET /v2/readyzThe server and all of its dependencies work, and the recent error rate is normal. It returns an error when other clients see too many errors, even if the servers and their subsystems are reachable.

Each endpoint returns 200 when the check passes and 500 when it fails.

Request

curl --include "https://api.sandbox.squake.earth/v2/healthz"

The same paths work on production at https://api.squake.earth.

Which check to use

  • Use healthz to test connectivity, for example from a new server, through a proxy, or before your first authenticated request.
  • Use readyz in monitoring, or before a large batch run, to check that SQUAKE is fully operational.

For incidents and maintenance, see the SQUAKE status page. You can subscribe to updates there.

On this page

GET/v2/healthz

Run this request against the sandbox with your test key.

Open in API reference