API-Dokumentation
Dies ist die Dokumentation für die verfügbaren API-Endpunkte, die auf der REST-Architektur basieren. Alle API-Endpunkte geben eine JSON-Antwort mit den standardmäßigen HTTP-Antwortcodes zurück und erfordern eine Bearer-Authentifizierung über einen API-Schlüssel.
Authentifizierung
Alle API-Endpunkte erfordern einen API-Schlüssel, der mit der Bearer-Authentifizierungsmethode gesendet wird.
Authorization: Bearer {api_key}
curl --request GET \
--url 'https://pingthing.de/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://pingthing.de/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
Fehler
Unsere API verwendet herkömmliche HTTP-Statuscodes, um den Erfolg oder Misserfolg einer Anfrage anzuzeigen.
{
"errors": [
{
"title": "Du hast keinen Zugriff auf die API.",
"status": 401
}
]
}
200 Anfrage erfolgreich abgeschlossen
400 Bad Request - Erforderliche Parameter fehlen oder sind ungültig
401 Unautorisiert - API-Schlüssel fehlt oder ist ungültig
404 Die angeforderte Ressource wurde nicht gefunden
429 Zu viele Anfragen - Limit überschritten
500 Interner Serverfehler – das bedeutet, dass ein Problem auf unserer Seite vorliegt.
Alle API-Endpunkte arbeiten mit der Zeitzone UTC, sofern nichts anderes angegeben ist.
Benutzer
Uptime-Monitore
DNS-Monitor
Server-Monitor
Heartbeats
Domain-Namen
Game servers
Benachrichtigungs-Handler
Status-Seiten
Statusseitenstatistiken
Vorfälle
Projekte
Meine Teams
Teammitglieder
Teammitglied
Kontoprotokolle