API Dokumentation
Übersicht über die REST API. Wähle links eine Ressource aus.
KI / LLM Text-Exporte
- LLMS-Index für KI-Agenten
- LLMS-Vollreferenz für KI-Ingestion
- Deutscher LLMS-Index für KI-Agenten
- Deutsche LLMS-Vollreferenz für KI-Ingestion
Base URL
Alle Beispiele nutzen eine Platzhalter-Base-URL:
BASE_URL="https://uptimeify.io"Authentifizierung
Die meisten Endpunkte benötigen Authentifizierung.
TOKEN="wsm_<dein-api-token>"
curl -H "Authorization: Bearer $TOKEN" "$BASE_URL/api/websites"API-Tokens aus dem Dashboard starten immer mit wsm_. Bitte den kompletten Token (inkl. Prefix) verwenden – sonst kommt 401 Unauthorized.
UUID-Pfadparameter
Bei migrierten Ressourcen verwenden die Docs und Beispiele die publicId-UUID im Pfad.
- Nutze UUIDs in Pfaden wie
/api/websites/:websitePublicId,/api/customers/:customerPublicId,/api/organizations/:organizationPublicId,/api/incidents/:incidentPublicId,/api/customer-ips/:customerIpPublicId,/api/customer-domains/:customerDomainPublicIdund monitor-spezifischen:...PublicId-Parametern. - Interne numerische
id-Felder können in Responses weiterhin vorkommen. - Query-/Body-Felder wie
customerId,websiteIdoderorganizationIdbleiben numerisch, sofern die jeweilige Endpoint-Seite nichts anderes sagt.
Antworten und Fehler
-
2xxbedeutet Erfolg -
4xxbedeutet Request/Auth-Problem -
5xxbedeutet Serverfehler
Beispiel-Fehlerantwort:
{
"statusCode": 401,
"statusMessage": "Unauthorized"
}