---
title: "API Dokumentation"
description: "Übersicht über die REST API. Wähle links eine Ressource aus."
---

## KI / LLM Text-Exporte

- [LLMS-Index für KI-Agenten](https://uptimeify.io/llms)
- [LLMS-Vollreferenz für KI-Ingestion](https://uptimeify.io/llms-full)
- [Deutscher LLMS-Index für KI-Agenten](https://uptimeify.io/de/llms)
- [Deutsche LLMS-Vollreferenz für KI-Ingestion](https://uptimeify.io/de/llms-full)

## Base URL

Alle Beispiele nutzen eine Platzhalter-Base-URL:

```bash
BASE_URL="https://uptimeify.io"
```

## Authentifizierung

Die meisten Endpunkte benötigen Authentifizierung.

```bash
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/:customerDomainPublicId` und monitor-spezifischen `:...PublicId`-Parametern.
- Interne numerische `id`-Felder können in Responses weiterhin vorkommen.
- Query-/Body-Felder wie `customerId`, `websiteId` oder `organizationId` bleiben numerisch, sofern die jeweilige Endpoint-Seite nichts anderes sagt.

## Antworten und Fehler

- `2xx` bedeutet Erfolg
- `4xx` bedeutet Request/Auth-Problem
- `5xx` bedeutet Serverfehler

- [Fehlerliste und bekannte API-Fallen](./fehlerliste-und-bekannte-fallen)

Beispiel-Fehlerantwort:

```json
{
 "statusCode": 401,
 "statusMessage": "Unauthorized"
}
```