Skip to content
Proud to collaborate with Microsoft for Startups

lumen.fingerprint-rule.create ​

Create a Lumen regex-based fingerprint override rule.

Create a Lumen fingerprint override rule via POST /api/fingerprint-rules.

See module docstring for tenancy, idempotency, and cache-invalidation notes.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-lumen
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuidstringYes—Public UUID of the calling organization (pass-through on output; does not scope the Lumen insert — service-key path is always global).
patternstringYes—Valid Python re regex. Lumen validates the regex on insert; an invalid pattern returns HTTP 422.
fingerprint_keystringYes—Deterministic key under which matching errors are grouped.
match_fieldstringNo—One of 'message', 'traceback', 'any'. Defaults to 'message' on Lumen.
title_overridestringNo—Human-readable title for the ErrorGroup created by this rule. Omit to let Lumen derive the title.
priorityintegerNo—Evaluation order; lower values are checked first. Defaults to 0.
projectstringNo—Project scope; accepts wildcards (* / prefix-* / -suffix). Defaults to '' (all projects).
enabledbooleanNo—Whether the rule is active. Defaults to true.
workflow_run_idstringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
rule_uuidstringNo—UUID of the created rule (Lumen response['id'] via public_id_field()).
patternstringNo——
match_fieldstringNo——
fingerprint_keystringNo——
title_overridestringNo——
priorityintegerNo——
projectstringNo——
enabledbooleanNo——
created_atstringNo——
organization_uuidstringNo——
workflow_run_idstringNo——
errorstringNo——
http_statusintegerNo——
lumen_detailstringNo——
error_typestringNo——
failure_reasonstringNo——
failed_stepstringNo——
failed_layerstringNo——
failed_at_statestringNo——

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