API Documentation

Ping

Health-check endpoint that confirms your API key is valid and returns the round-trip response time.

Request

GET /api/v1/ping

No query parameters. No required scopes beyond a valid API key.

Headers

Header Required Value
Authorization Yes Bearer YOUR_API_KEY

Response

{
  "status": "ok",
  "authenticated": true,
  "key": {
    "prefix": "sq_live_a94e",
    "name": "My Key",
    "scopes": ["vps:read", "domains:read"]
  },
  "responseTimeMs": 12,
  "timestamp": "2026-03-27T12:00:00.000Z"
}

Response Fields

Field Type Description
status string Always "ok" on success
authenticated boolean Always true on success
key.prefix string First 14 characters of your API key
key.name string Display name you gave the key
key.scopes string[] Scopes assigned to this key
responseTimeMs number Server-side processing time in milliseconds
timestamp string ISO 8601 timestamp of the response

Example

curl https://hosting.site.quest/api/v1/ping \
  -H "Authorization: Bearer sq_live_a94ecfca096d..."