API-Dokumentation

Ping

Health-Check-Endpunkt, der bestätigt, dass dein API-Schlüssel gültig ist, und die Antwortzeit zurückgibt.

Anfrage

GET /api/v1/ping

Keine Abfrageparameter. Keine besonderen Scopes erforderlich — ein gültiger API-Schlüssel genügt.

Header

Header Erforderlich Wert
Authorization Ja Bearer DEIN_API_SCHLÜSSEL

Antwort

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

Antwortfelder

Feld Typ Beschreibung
status string Immer "ok" bei Erfolg
authenticated boolean Immer true bei Erfolg
key.prefix string Erste 14 Zeichen deines API-Schlüssels
key.name string Anzeigename des Schlüssels
key.scopes string[] Dem Schlüssel zugewiesene Berechtigungen
responseTimeMs number Serverseitige Verarbeitungszeit in Millisekunden
timestamp string ISO-8601-Zeitstempel der Antwort

Beispiel

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