Sign in

Health

GET/health/ready

Readiness check (database only)

Auth
No key
Scope
None
Search quota
Free
Idempotency
Not required

Responses

200 · TerseHealthDto

Ready.

503 · TerseHealthDto

Not ready — the database is unreachable.

Response headers

Set on every response of this operation, successful or not.

HeaderTypeMeaning
X-RateLimit-LimitintegerUpper limit of the class that applied to this request.
X-RateLimit-RemainingintegerRemaining requests in the running window.
X-RateLimit-ResetintegerUnix time at which the window starts anew.
X-Request-Idstring (uuid)Identifier of this request. Quote it in any support request — including on a successful response, in case the outcome becomes questionable later.

Example

GET /health/ready
curl -sS "$VACABEE_API_URL/health/ready"

Set VACABEE_API_URL to https://api.vacabee.com with a live key, or to https://sandbox-api.vacabee.com with a vcb_test_ key. Binding a host to one kind of key is planned and is not enforced by the host yet, so nothing stops a key from being answered at the wrong base URL — assert the prefix against your configured URL yourself. What the sandbox answers

TypeScript SDK

await vacabee.request('GET', '/health/ready');

This page does not name a typed method for this route yet. request reaches every route of the API, and there you set the idempotency key yourself. Installing and using the SDK