CREDENTIALS

Check your credentials

GET


                    roadrunnerzw.com/api/v1/ping

Confirms the API key works and reports the client it belongs to, its scopes, and whether it is a test key.

server_time is the quickest way to diagnose a signing problem: if your clock differs from ours by more than 300 seconds, every signed request fails with timestamp_out_of_range.

REQUEST

curl -X GET https://roadrunnerzw.com/api/v1/ping \
  -H 'Authorization: Bearer rr_live_your_key_id' \
  -H 'X-RR-Timestamp: $(date +%s)' \
  -H 'X-RR-Signature: $SIGNATURE'

RESPONSE 200

{
    "ok": true,
    "client": "ABC",
    "key_id": "rr_live_EXAMPLEKEYID0000000000000",
    "scopes": [
        "deliveries:read",
        "deliveries:write",
        "webhooks:manage"
    ],
    "test_mode": false,
    "server_time": "2026-09-21T14:30:00+02:00"
}

Responses

200 OK

The key is valid. Shows the client it belongs to and what it may do.

401 Unauthenticated

The signature, key or timestamp did not check out. Also returned for a revoked key, and for a timestamp more than 300 seconds from ours.

429 Too many requests

Too many requests for this client. Back off and retry; the response carries Retry-After and X-RateLimit-* headers.