Skip to content
Proud to collaborate with Microsoft for Startups

lumen.ingest-rule.create ​

Create a Lumen ingest filter rule (drop or sample) for a project/level/source.

Create a Lumen ingest filter rule (drop / sample) via the Lumen service key.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-lumen
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes—Org UUID forwarded as X-Lumen-Organization-UUID header.
actionstringNo—'drop' or 'sample'. Default: 'drop'.
projectstringNo—Project glob. Default: '*'.
levelstringNo—Log level filter. Default: '' (any).
sourcestringNo—Source tag filter. Default: '' (any).
sample_ratefloatNo—Retention probability [0.0, 1.0]. Default: 1.0.
enabledbooleanNo—Whether the rule is active on creation. Default: true.
workflow_run_idstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
rule_idstringNo—Public UUID of the created rule (sourced from response['id']).
projectstringNo——
levelstringNo——
sourcestringNo——
actionstringNo——
sample_ratefloatNo——
enabledbooleanNo——
created_atstringNo——
organization_uuidstringNo—Echoed from initial_data for audit traceability.
workflow_run_idstringNo——
errorstringNo——
error_typestringNo——
failure_reasonstringNo——
failed_stepstringNo——
failed_layerstringNo——
failed_at_statestringNo——
http_statusintegerNo——
reasonstringNo——

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.ingest-rule.create",
  "initial_data": {
    "organization_uuid": "value"
  }
}