API-Dokumentation

HTTP Basic-Authentifizierung · XML-Antworten · REST

Melden Sie sich an, um Ihre API-Zugangsdaten anzuzeigen und die Endpunkte direkt von dieser Seite aus zu testen.

Anmelden

Authentifizierung

Alle Anfragen verwenden HTTP Basic-Authentifizierung (RFC 7617). Übergeben Sie Ihren API-Login und Ihr Passwort im Authorization-Header.

curl -u "API_IDENTIFIER:API_SECRET_KEY" \
     https://dev.webcron.org/cron.get

Endpunkte

GET /time — Verbindung prüfen

Prüft, ob die Zugangsdaten gültig und der Dienst verfügbar ist.

Antwort

<?xml version="1.0"?>
<rsp status="ok" timestamp="1745234567"/>
GET /cron.get — Cronjobs auflisten

Gibt Ihre Cronjobs mit Paginierung zurück.

Parameter

Name Typ Standard Description
page int 1 Seitennummer
perpage int 100 Ergebnisse pro Seite (max. 100)

Antwort

<?xml version="1.0"?>
<rsp status="ok" total="3">
  <cron id="42" name="My job" url="https://example.com/run"
        status="1" time_out="30" one_off="0">
    <time minute="*/5" hour="*" day="*" weekday="*" month="*"/>
  </cron>
</rsp>
POST /cron.add — Cronjob erstellen

Erstellt einen neuen Cronjob.

Parameter

Name Typ Standard Description
name * string — Cronjob-Name
url * string — Aufzurufende URL
minute string * Cron-Ausdruck — Minute
hour string * Cron-Ausdruck — Stunde
day string * Cron-Ausdruck — Tag des Monats
weekday string * Cron-Ausdruck — Wochentag (0-6)
month string * Cron-Ausdruck — Monat
time_out int 30 Timeout in Sekunden (30, 180, 600, 1800, 3600)

Antwort

<?xml version="1.0"?>
<rsp status="ok" id="43"/>
POST /cron.edit — Cronjob bearbeiten

Aktualisiert die angegebenen Felder eines vorhandenen Cronjobs.

Parameter

Name Typ Standard Description
id * int — Cronjob-ID
name string — Neuer Name
url string — Neue URL
status int — Aktivieren (1) oder deaktivieren (0)
minute,hour,day,weekday,month string — Zeitplan-Felder

Antwort

<?xml version="1.0"?>
<rsp status="ok"/>
POST /cron.delete — Cronjob löschen

Löscht einen Cronjob dauerhaft.

Parameter

Name Typ Standard Description
id * int — Cronjob-ID

Antwort

<?xml version="1.0"?>
<rsp status="ok"/>
POST /cron.state — Aktivieren / Deaktivieren

Ändert den Aktivierungsstatus eines Cronjobs.

Parameter

Name Typ Standard Description
id * int — Cronjob-ID
status * int — 1 = aktiv, 0 = inaktiv

Antwort

<?xml version="1.0"?>
<rsp status="ok"/>
GET /cron.logs — Ausführungsverlauf

Gibt die letzten Ausführungen eines Cronjobs zurück.

Parameter

Name Typ Standard Description
id * int — Cronjob-ID
perpage int 50 Anzahl der zurückzugebenden Log-Einträge

Antwort

<?xml version="1.0"?>
<rsp status="ok">
  <logs>
    <log date="2026-04-21 10:00:00" http_code="200" total_time="0.342"/>
    <log date="2026-04-21 09:00:00" http_code="200" total_time="0.298"/>
  </logs>
</rsp>

Fehlerantworten

Bei einem Fehler ist der HTTP-Status 4xx und der XML-Body enthält die Details.

<?xml version="1.0"?>
<rsp status="error" error="Cron not found"/>