Workflows API

DRAFT — Internal Developer Use Only

This API reference is for internal development teams.

Overview

What it is: The workflows API manages automation workflows that chain triggers to actions. A workflow defines which events trigger which actions, with optional conditions and sequencing.

Endpoints

Method	Path	Description	Auth required
GET	/api/v1/workflows	List all workflows	JWT + API token
GET	/api/v1/workflows/:workflowID	Get a specific workflow	JWT + API token
PUT	/api/v1/workflows/:workflowID	Update a workflow	JWT + API token
PUT	/api/v1/workflows/:workflowID/enable	Enable a workflow	JWT + API token
PUT	/api/v1/workflows/:workflowID/disable	Disable a workflow	JWT + API token
DELETE	/api/v1/workflows/:workflowID	Delete a workflow	JWT + API token

---

GET /api/v1/workflows

List all configured workflows.

Request:

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

Response (200):

[
  {
    "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

Enable a disabled workflow.

Request:

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

Response (200):

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

---

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

Disable an active workflow. The workflow remains configured but stops processing triggers.

Request:

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

Response (200):

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