Liveness check

GET

/ping

const url = 'https://api.partners.collaterate.com/v1/ping';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.partners.collaterate.com/v1/ping

Unauthenticated. Returns 200 if the gateway and its edge are up. Does not touch the database, the authorizer, or anything partner-specific – a failing /v1/me or /v1/orders alongside a healthy /v1/ping tells you the problem is in your credential or the data path, not the network.

Responses

200

The service is reachable.

application/json

object

status

required

string

Allowed value: ok

Examples

default

{
  "status": "ok"
}

403

Blocked by the edge WAF’s rate-based rule (a per-IP backstop independent of the per-partner usage plans), or by an AWS managed rule set. This is a WAF response, not an application response – it does not carry an application/problem+json body, and it is the one case in this API where a 403 does not mean “your token lacks a scope.”