GET/api/v6/utilities/ping

Ping

Confirms your API key is valid and shows what the API knows about the caller.

Scope

Any valid API key

Usage limit

20 requests per minute

Returns the caller state: it confirms the API key is valid and shows the key facts the API knows about the requester.

Use it as a smoke test after configuring your credentials. A 200 means your integration is ready to call the rest of the endpoints.

That the key is valid (pong: true).
The API version that served the call.
The public IP the call originates from.

Details about the organization, the cost center and the enabled services do not travel in this response: they live in /api/v6/account/organization, /api/v6/account/cost-centers and /api/v6/catalog/services.

Responses

200

The key is valid.

{
  "success": true,
  "data": {
    "pong": true,
    "apiVersion": "v6",
    "client": { "ip": "203.0.113.45" }
  },
  "meta": {
    "requestId": "b9b1704baffab21150213c02fd853975",
    "timestamp": "2026-06-04T19:43:59+00:00",
    "responseTimeMs": 4.24
  }
}

401

Invalid or missing credentials. The error.code tells you the specific reason.

403

Credentials are valid, but the organization cannot run the request.

429

Request limit exceeded. Wait the time reported in Retry-After.

503

Service temporarily unavailable. Retry after the window reported in Retry-After.

504

Timed out while processing the request. Safe to retry.

Possible errors

Codes this endpoint can return in error.code. The full detail lives in the catalog.

401AUTH_REQUIREDNo Bearer token was sent, and every call requires one.401AUTH_INVALID_KEYThe API key is not recognized: wrong format, revoked or expired.401AUTH_COST_CENTER_DISABLEDThe cost center bound to the key is disabled.403ACCOUNT_NOT_ACTIVEYour organization is suspended or closed.403ACCOUNT_BLOCKEDA full block is active: every call is rejected.403ACCOUNT_READ_ONLYRead-only mode: only GET, HEAD and OPTIONS pass.403ACCOUNT_CONFIG_NOT_FOUNDWe could not load the organization behind your key.429RATE_DDOS_EXCEEDEDUnusually high volume from your source IP.429RATE_TPS_EXCEEDEDYou exceeded your organization quota for this endpoint.503INFRA_CACHE_UNAVAILABLEAn internal component is temporarily unavailable.503INFRA_DB_CONNECTION_ERRORAn internal service was momentarily unreachable.504INFRA_DB_QUERY_TIMEOUTAn internal query took too long and was cut off.

See the full catalog

Scope and limits

Responses

Possible errors