Skip to main content

Check that the API is reachable

GET 

/ping

Returns pong and the server time.

Needs no token. POST /ping behaves the same. Other methods return 405 with an empty body when a valid token is sent, and 401 without one.

If a token is supplied anyway (an Authorization or x-access-token header, or a token field in the body or query string), it is still checked: an invalid or expired token returns 401, and an access token restricted by scopes returns 403 (Scope not allowed by token). Leave the token off when you only want to test reachability.

Required role: none (no authentication needed).

Responses​

The API is up.