API-Dokumentation

Dies ist die Dokumentation der verfügbaren API-Endpunkte, die auf der REST-Architektur basieren. Alle API-Endpunkte geben eine JSON-Antwort mit Standard-HTTP-Statuscodes zurück und erfordern eine Bearer-Authentifizierung mittels API-Key.

Get your own API Key

Base-URL

Authentifizierung

Alle API-Endpunkte erfordern einen API-Key, der über die Bearer Authentication-Methode übergeben wird.

Authorization: Bearer {api_key}

Beispiel

curl --request GET \
--url 'https://peaknode.de/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

Beispiel

{
    "errors": [
        {
            "title": "Sie haben keinen Zugriff auf die API.",
            "status": 401
        }
    ]
}

Status codes

200 Request completed successfully

400 Bad request - Required parameters are missing or invalid

401 Unauthorized - API key is missing or invalid

404 The requested resource was not found

429 Too many requests - Rate limit exceeded

500 Internal server error - this means there is a problem on our end

Alle API-Endpunkt-Ergebnisse basieren auf der UTC Zeitzone, sofern nicht anders angegeben.

Benutzer

Uptime-Monitoring

DNS-Monitoring

Server-Monitoring

Heartbeats

Domain-Namen

Benachrichtigungskanäle

Statusseiten

Statusseiten-Statistiken

Vorfälle

Projekte

Teams

Team-Mitglieder

Team-Zugehörigkeiten

Zahlungen

Account-Logs