Ping
Check API availability without an API key.
Request
GET /v1/ping
Checks that the API is up. Needs no key.
No authentication is required.
This route is available through REST only.
No request parameters are needed.
Response
| HTTP status | Result |
|---|---|
200 |
The API answers. |
Required fields are required within their containing object. Notes identify fields that apply only to a particular response alternative.
| Response field | Type | Required in object | Notes |
|---|---|---|---|
data |
Ping | Yes | |
data.object |
"ping" |
Yes | |
data.status |
"ok" |
Yes |
Errors
| HTTP status | Meaning |
|---|---|
400 |
credential_in_url: an API key was sent in the URL. |
429 |
rate_limited. |
503 |
One of: service_unavailable. |
See errors and recovery and safe retries before repeating a write.
The public OpenAPI document lists generally available API families. Alpha operations may not appear in that document; their request and response fields are listed on this page. Use the API Playground to inspect a real response with your connection's access.