Gorilla Dash

arrow_back Back to Knowledge Base

Ping and health check: is it me or is it you?

download Download PDF

When an integration stops working, the first question is always whether the problem is your credentials, your request, or the API. These two endpoints answer it in seconds.

Ping: are my credentials good?

GET https://api.gorilladash.com/api/v1/ping, with your two authentication headers. A 201 with {"ping":true} in the data means the key and access token are valid and the API is switched on for your organisation.

ResponseWhat it tells you
201Credentials are good. Any failure elsewhere is about that request, not your key.
401The key and access token are missing, mismatched or wrong.
403Credentials are fine, but the RESTful API is switched off for your organisation.
429You are over the rate limit — which is itself worth knowing.
THE FIRST CALL YOU SHOULD EVER MAKE
Before you write a single line of integration code, ping. It confirms the headers are spelled right, the credentials were copied whole, and the API is on. It removes half the possible explanations from everything that comes after.

Health check: is the API up?

GET https://api.gorilladash.com/api/v1/up needs no credentials at all. It returns 200 with {"status":"ok","checks":{"database":true,"redis":true}} when the service can reach everything it depends on, and 503 when it cannot.

It is an infrastructure probe, so it deliberately breaks the usual conventions: real 200 and 503 status codes rather than the standard 201, and a flat body with no envelope.

Using them to diagnose

/up/pingConclusion
200201The API and your credentials are both fine. Look at the specific request that is failing.
200401The API is fine. Your key or access token is wrong, or someone regenerated it.
200403The API is fine. Someone has switched on Disable RESTful API in Gorilla Settings — switch it back off to restore access.
503anythingThe API is unhealthy. Wait and retry — this is not something you can fix.
no answerno answerA network or DNS problem between you and api.gorilladash.com.

Do not monitor with these

A PING EVERY SECOND WILL RATE-LIMIT YOU
/ping counts against your rate limit like any other call, so it is for diagnosing a problem, not for a monitor that runs constantly. /up sits outside the limit because it is what our own infrastructure probes, but it tells you nothing about your key. Either way, a heartbeat once every few minutes is more than enough.