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 ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-lumen |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | string | Yes | — | Org UUID forwarded as X-Lumen-Organization-UUID header. |
action | string | No | — | 'drop' or 'sample'. Default: 'drop'. |
project | string | No | — | Project glob. Default: '*'. |
level | string | No | — | Log level filter. Default: '' (any). |
source | string | No | — | Source tag filter. Default: '' (any). |
sample_rate | float | No | — | Retention probability [0.0, 1.0]. Default: 1.0. |
enabled | boolean | No | — | Whether the rule is active on creation. Default: true. |
workflow_run_id | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
rule_id | string | No | — | Public UUID of the created rule (sourced from response['id']). |
project | string | No | — | — |
level | string | No | — | — |
source | string | No | — | — |
action | string | No | — | — |
sample_rate | float | No | — | — |
enabled | boolean | No | — | — |
created_at | string | No | — | — |
organization_uuid | string | No | — | Echoed from initial_data for audit traceability. |
workflow_run_id | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failure_reason | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
failed_at_state | string | No | — | — |
http_status | integer | No | — | — |
reason | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "lumen.ingest-rule.create",
"initial_data": {
"organization_uuid": "value"
}
}