Skip to navigation
Gorilla Dash RESTFul APISystem

Ping (authenticated)

View as Markdown

Shallow authenticated probe — the fastest way to confirm an API key and secret are valid and that the RESTFul API is enabled for the organisation.

Touches no database or cache. Returns the standard envelope with {"ping": true} and HTTP 201.

  • 401 — bad or missing GorillaDash-Api-Key / GorillaDash-Api-Secret.
  • 403 — credentials are valid but the RESTFul API is disabled for that organisation.

For an unauthenticated infrastructure probe (that does check Postgres and Redis) use GET /api/v1/up instead.

Headers

GorillaDash-Api-KeystringOptional
Gorilla Dash API Key
GorillaDash-Api-SecretstringOptional
Gorilla Dash API Secret
X-Requested-WithstringOptional

Response

Created
statusinteger
successboolean
dataobject