Sign in

Meta

GET/v1/ping

Reachability check. No API key required.

Deliberately without a key: someone starting out has to be able to prove that he reaches us before he sorts out credentials. A 401 here would hide a networking problem behind a permission problem.

Auth
No key
Scope
None
Rate limit
READ
Search quota
Free
Idempotency
Not required

Responses

200 · PingDto

The API is reachable.

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 /v1/ping
curl -sS "$VACABEE_API_URL/v1/ping"

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.ping(…);

The typed method sends the right headers, derives the idempotency key where one is required, and returns the response type generated from this document. Installing and using the SDK