Skip to content

Workflows-API

ENTWURF — Nur für interne Entwickler

Diese API-Referenz ist für interne Entwicklungsteams bestimmt.

Übersicht

Was es ist: Die Workflows-API verwaltet Automatisierungs-Workflows, die Auslöser mit Aktionen verketten. Ein Workflow definiert, welche Ereignisse welche Aktionen auslösen, mit optionalen Bedingungen und Reihenfolgen.

Endpunkte

MethodePfadBeschreibungAuthentifizierung erforderlich
GET/api/v1/workflowsAlle Workflows auflistenJWT + API-Token
GET/api/v1/workflows/:workflowIDEinen bestimmten Workflow abrufenJWT + API-Token
PUT/api/v1/workflows/:workflowIDEinen Workflow aktualisierenJWT + API-Token
PUT/api/v1/workflows/:workflowID/enableEinen Workflow aktivierenJWT + API-Token
PUT/api/v1/workflows/:workflowID/disableEinen Workflow deaktivierenJWT + API-Token
DELETE/api/v1/workflows/:workflowIDEinen Workflow löschenJWT + API-Token

GET /api/v1/workflows

Alle konfigurierten Workflows auflisten.

Anfrage:

http
GET /api/v1/workflows
Authorization: Bearer <token>

Antwort (200):

json
[
  {
    "workflowID": "wf-uuid-001",
    "name": "High Threat Alert",
    "enabled": true,
    "trigger": "threat-score-above-80",
    "actions": ["action-uuid-001", "action-uuid-002"]
  }
]

PUT /api/v1/workflows/:workflowID/enable

Einen deaktivierten Workflow aktivieren.

Anfrage:

http
PUT /api/v1/workflows/wf-uuid-001/enable
Authorization: Bearer <token>

Antwort (200):

json
{
  "workflowID": "wf-uuid-001",
  "enabled": true
}

PUT /api/v1/workflows/:workflowID/disable

Einen aktiven Workflow deaktivieren. Der Workflow bleibt konfiguriert, verarbeitet aber keine Auslöser mehr.

Anfrage:

http
PUT /api/v1/workflows/wf-uuid-001/disable
Authorization: Bearer <token>

Antwort (200):

json
{
  "workflowID": "wf-uuid-001",
  "enabled": false
}

Hydden Documentation and Training Hub