API-Dokumentation

Integrieren Sie EstaCaido mit Ihren Anwendungen

Erste Schritte

Mit der EstaCaido-API verwalten Sie Ihre Monitore, sehen Vorfälle ein, konfigurieren Alarme und mehr direkt aus Ihrem eigenen Code. Alle API-Endpunkte verwenden JSON für Anfrage- und Antwortinhalte.

Basis-URL

https://www.estacaido.com/api/v1/

Ratenlimits

Jedes API-Token kann bis zu 100 Anfragen pro Minute senden. Anfragen über diesem Limit erhalten eine 429 Too Many Requests-Antwort.

Authentifizierung

Verwenden Sie für alle API-Anfragen eine tokenbasierte Authentifizierung. Geben Sie Ihr Token im Authorization-Header an.

Authentifizierungstoken abrufen

POST /api/v1/auth/token/
Anfrage
curl -X POST https://www.estacaido.com/api/v1/auth/token/ \
  -H "Content-Type: application/json" \
  -d '{"username": "your@email.com", "password": "yourpassword"}'
Antwort
{
  "token": "your-api-token-here"
}

Verwenden Sie das Token im Authorization-Header

Authorization: Token your-api-token-here

Monitore

Verwalten Sie Ihre Website-Monitore.

Monitore auflisten

GET /api/v1/monitors/
Antwort
[
  {
    "id": 1,
    "name": "Production API",
    "company": {
      "id": 1,
      "website": "api.example.com"
    },
    "check_type": "http",
    "check_interval": 300,
    "is_active": true,
    "is_paused": false,
    "last_check_at": "2024-01-15T10:30:00Z",
    "created_at": "2024-01-01T00:00:00Z"
  }
]

Monitor erstellen

POST /api/v1/monitors/
Parameter
name Erforderlich Name des Monitors
domain Erforderlich Zu überwachende Domain, zum Beispiel example.com
check_interval Optional Prüfintervall in Sekunden, einer von 30, 60, 300, 600, 900, 1800, 3600. Standard: 300
check_type Optional Einer dieser Werte: http, https, ping. Standard: https

Monitor abrufen

GET /api/v1/monitors/{id}/

Monitor aktualisieren

PUT /api/v1/monitors/{id}/

Monitor löschen

DELETE /api/v1/monitors/{id}/

Monitor pausieren

POST /api/v1/monitors/{id}/pause/

Monitor fortsetzen

POST /api/v1/monitors/{id}/resume/

Monitor-Statistiken abrufen

GET /api/v1/monitors/{id}/statistics/
Parameter
days Optional Anzahl der einzubeziehenden Tage. Standard: 30

Vorfälle

Sehen Sie Ausfallvorfälle und ihren Verlauf ein.

Vorfälle auflisten

GET /api/v1/incidents/
Parameter
status Optional Nach Status filtern: ongoing, resolved
monitor Optional Nach Monitor-ID filtern

Vorfall abrufen

GET /api/v1/incidents/{id}/

Alarme

Konfigurieren Sie Alarmbenachrichtigungen für Ihre Monitore.

Alarme auflisten

GET /api/v1/alerts/

Alarm erstellen

POST /api/v1/alerts/
Parameter
monitor Erforderlich Monitor-ID
alert_type Erforderlich Einer dieser Werte: email, sms, slack, discord, webhook, pagerduty, teams
recipients Erforderlich Empfängeradressen oder Webhook-URLs
alert_on_down Optional Benachrichtigen, wenn die Website ausfällt (Standard: true)
alert_on_recovery Optional Benachrichtigen, wenn die Website wieder erreichbar ist (Standard: true)

Alarm aktualisieren

PUT /api/v1/alerts/{id}/

Alarm löschen

DELETE /api/v1/alerts/{id}/

Statusseiten

Erstellen und verwalten Sie öffentliche Statusseiten.

Statusseiten auflisten

GET /api/v1/status-pages/

Statusseite erstellen

POST /api/v1/status-pages/
Parameter
title Erforderlich Titel der Statusseite
slug Erforderlich URL-Slug (z. B. my-status-page)
description Optional Beschreibungstext
is_public Optional Öffentlich zugänglich machen (Standard: true)

Teams

Verwalten Sie Teamzugriff und Zusammenarbeit.

Teams auflisten

GET /api/v1/teams/

Team erstellen

POST /api/v1/teams/

Team abrufen

GET /api/v1/teams/{id}/

Codebeispiele

Python

import requests

API_TOKEN = 'your-api-token'
BASE_URL = 'https://www.estacaido.com/api/v1'

headers = {
    'Authorization': f'Token {API_TOKEN}',
    'Content-Type': 'application/json'
}

# List all monitors
response = requests.get(f'{BASE_URL}/monitors/', headers=headers)
monitors = response.json()
print(monitors)

# Create a new monitor
new_monitor = {
    'name': 'My Website',
    'domain': 'example.com',
    'check_interval': 300
}
response = requests.post(f'{BASE_URL}/monitors/', json=new_monitor, headers=headers)
print(response.json())

JavaScript

const API_TOKEN = 'your-api-token';
const BASE_URL = 'https://www.estacaido.com/api/v1';

const headers = {
    'Authorization': `Token ${API_TOKEN}`,
    'Content-Type': 'application/json'
};

// List all monitors
fetch(`${BASE_URL}/monitors/`, { headers })
    .then(res => res.json())
    .then(monitors => console.log(monitors));

// Create a new monitor
fetch(`${BASE_URL}/monitors/`, {
    method: 'POST',
    headers,
    body: JSON.stringify({
        name: 'My Website',
        domain: 'example.com',
        check_interval: 300
    })
})
.then(res => res.json())
.then(data => console.log(data));

cURL

# List all monitors
curl -X GET https://www.estacaido.com/api/v1/monitors/ \
  -H "Authorization: Token your-api-token"

# Create a new monitor
curl -X POST https://www.estacaido.com/api/v1/monitors/ \
  -H "Authorization: Token your-api-token" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Website", "domain": "example.com", "check_interval": 300}'

Bereit für den Start?

Registrieren Sie sich kostenlos und holen Sie sich Ihr API-Token, um mit der Integration zu beginnen.

Kostenlos registrieren API-Token abrufen