Skip to content
Proud to collaborate with Microsoft for Startups

lumen.alert-rule.delete ​

Permanently delete a Lumen alert rule by its public UUID.

Delete a Lumen alert rule by UUID, scoped to the caller's organization.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-lumen
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes—Caller's organization UUID; passed as X-Lumen-Organization-UUID.
alert_rule_uuidstringYes—Public UUID of the alert rule to delete (non-numeric).
workflow_run_idstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringNo——
alert_rule_uuidstringNo——
deletedbooleanNo——
reasonstringNo—not_found
http_statusintegerNo—Present when reason is lumen_error.
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——
workflow_run_idstringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "lumen.alert-rule.delete",
  "initial_data": {
    "organization_uuid": "value",
    "alert_rule_uuid": "value"
  }
}