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 benötigen eine Bearer-Authentifizierung über einen API-Schlüssel.

Eigenen API-Schluessel abrufen

Basis-URL

Authentifizierung

Alle API-Endpunkte erfordern einen API-Schlüssel, der durch die Bearer-Authentifizierungsmethode gesendet wird.

Authorization: Bearer {api_key}

Beispiel

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

Fehler

Unsere API verwendet die ueblichen HTTP-Statuscodes, um den Erfolg oder Fehler einer Anfrage anzuzeigen.

Beispiel

{
    "errors": [
        {
            "title": "Sie haben keinen Zugang zur API.",
            "status": 401
        }
    ]
}

Statuscodes

200 Anfrage erfolgreich abgeschlossen

400 Fehlerhafte Anfrage - Erforderliche Parameter fehlen oder sind ungueltig

401 Nicht autorisiert - API-Schluessel fehlt oder ist ungueltig

404 Die angeforderte Ressource wurde nicht gefunden

429 Zu viele Anfragen - Ratenlimit ueberschritten

500 Interner Serverfehler - das bedeutet, dass auf unserer Seite ein Problem vorliegt

Alle API-Endpunktergebnisse funktionieren mit der UTC Zeitzone, sofern nicht anders angegeben.

Benutzer

Uptime-Monitore

DNS-Überwachungen

Serverüberwachungen

Heartbeats

Domains

Game-Server

Benachrichtigungs-Handler

Statusseiten

Statusseiten Statistiken

Vorfälle

Projekte

Eigene Domains

Meine Teams

Teammitglieder

Teammitglied

Kontozahlungen

Kontoprotokolle