StandaloneAPI referenceHealth

Liveness

Liveness, through Ovok's Signals gateway.

Liveness

MethodPath
GET/v1/signals/api/health
  • Sandbox: available
  • Staging: available
  • Production: unknown

Unauthenticated, always 200: the HTTP status reports that the process is serving, not that its dependencies are well, because this route gates container liveness. healthy is false while the database does not answer (db.ok); page on it.

Through ovok

  • Who can call it: any caller with an ovok access token, or a client id and secret. It needs no capability.

Request

No parameters or body.

Responses

StatusMeaning
200The service is up; db reports database reachability.
400The query carries a raw #, or more than 200 parameters.
401Your ovok access token, or your client id and secret, are missing or invalid.
429Too many requests. Retry after the seconds in Retry-After.
500ovok hit an unexpected fault, such as your project having no Signals submitter.
502Signals answered with something ovok couldn't use, or refused ovok's own credential.
503Signals is unavailable. Retry after the seconds in Retry-After.
504Signals did not answer in time.

Example

curl --request GET 'https://api.sandbox.ovok.com/v1/signals/api/health' \
  --user "${OVOK_CLIENT_ID}:${OVOK_CLIENT_SECRET}"

Last updated on

On this page