API-Referenz

Zeitpläne

Zeitpläne erstellen, in der Vorschau anzeigen, pausieren und ausführen.

Starten Sie einen gespeicherten Workflow nach einem Fahrplan. Jeder Schlüssel kann Zeitpläne auflisten und lesen und einen sofort starten; zum Erstellen, Ändern und Löschen ist ein Inhaber oder Admin nötig. Wie Starts funktionieren, beschreibt Zeitpläne.

Einen Zeitplan erstellen

POST/v1/schedules
Prüft, ob sich der Workflow zu einer Ausführung auflöst, die jetzt zugelassen würde, und speichert dann den Zeitplan. Antwortet mit 201 und dem Zeitplan.
Body
workflowstringerforderlich
Name des gespeicherten Workflows, der gestartet werden soll.
cronstringerforderlich
cron-Ausdruck mit fünf Feldern oder eine Kurzform wie @daily oder @every 90m. Höchstens einmal pro Minute.
timezonestring
IANA-Zeitzone, in der der Fahrplan gelesen wird, etwa Europe/Madrid. Standard UTC.
namestring
Eine Bezeichnung für Menschen. Bis zu 128 Zeichen.
inputany JSON
Eingabe für jede Ausführung. Bis zu 1 MiB.
max_cost_microsinteger
Budget für jede Ausführung. Wenn weggelassen, das Standardbudget.
skip_if_runningboolean
Einen Start überspringen, solange die vorherige Ausführung noch läuft. Standard true.
enabledboolean
Standard true.
curl -X POST $EPHEMERAL_URL/v1/schedules \
  -H "Authorization: Bearer $EPHEMERAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow": "welcome-new-customers",
    "name": "Weekday welcome emails",
    "cron": "0 9 * * 1-5",
    "timezone": "Asia/Tokyo",
    "input": { "signed_up": "yesterday" },
    "max_cost_micros": 200000
  }'
Von Ephemeral gesetzte Zeitplanfelder
next_run_atstring | null
Der nächste Start in UTC. null, solange der Zeitplan aus ist.
last_run_atstring
Wann der Zeitplan zuletzt fällig war.
last_run_idstring
Die Ausführung, die er zuletzt gestartet hat.
last_errorstring
Warum der letzte Start übersprungen wurde oder fehlgeschlagen ist oder warum der Zeitplan pausiert wurde. Nach einem erfolgreichen Start leer.
failuresinteger
Fehlgeschlagene Starts in Folge. Bei 5 schaltet sich der Zeitplan selbst aus.

Einen Fahrplan in der Vorschau anzeigen

POST/v1/schedules/preview
Prüft cron und timezone und liefert die nächsten fünf Startzeiten, ohne etwas zu speichern. Ein ungültiger Fahrplan liefert 400 mit dem Grund.
JSON
{ "next": ["2026-10-05T00:00:00Z", "2026-10-06T00:00:00Z", "2026-10-07T00:00:00Z", "2026-10-08T00:00:00Z", "2026-10-09T00:00:00Z"] }

Zeitpläne auflisten

GET/v1/schedules
Liefert {"items": [...]}, die ältesten zuerst. Mit ?workflow= listen Sie die Zeitpläne eines Workflows auf.

Einen Zeitplan abrufen

GET/v1/schedules/{id}

Einen Zeitplan aktualisieren

PATCH/v1/schedules/{id}
Senden Sie beliebige Felder der Erstellung; die übrigen bleiben unverändert. Ein neues cron oder timezone berechnet den nächsten Start ab jetzt. Setzen Sie enabled bei einem pausierten Zeitplan auf true, werden seine Fehlschläge zurückgesetzt.

Jetzt starten

POST/v1/schedules/{id}/run
Startet den Workflow jetzt mit der Eingabe und dem Budget des Zeitplans, außerhalb des Fahrplans. Antwortet mit 202 und der Ausführung, die die ID des Zeitplans trägt.

Einen Zeitplan löschen

DELETE/v1/schedules/{id}
Antwortet mit 204. Von ihm gestartete Ausführungen behalten ihre Aufzeichnung.

Ausführungen eines Zeitplans

GET /v1/runs?schedule={id} listet die Ausführungen auf, die ein Zeitplan gestartet hat, die neuesten zuerst, mit derselben Paginierung wie beim Auflisten von Ausführungen.

Eine Organisation kann bis zu 50 Zeitpläne haben.
© 2026 EphemeralProduziert von erni.works
esc

Keine Treffer für „“.