v57

latestOpenAPI 3.1.0Apache-2.0raw.githubusercontent.com2026-08-012143051018.3 KB

Rule

Create an Operation Rule

Create a new Operation Rule on the target Site. The rule definition is validated server-side by Flow; on validation failure no state changes (the request acts as a dry-run by way of its own validation step).

Rules are site-scoped and per (operationType, operationCode) tuple. The response echoes the submitted body with the assigned id.

Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

post/v2/org/{org}/nico/task/rule

Request body

siteIdstring uuid required

ID of the Site to create the rule on.

namestring required

Human-readable name of the rule.

descriptionstring

Optional free-form description.

operationType'PowerControl' | 'FirmwareControl' required

Operation type the rule applies to.

operationCodestring required

Operation code within the operation type (e.g. power_on).

Response

Rule was created.

idstring uuid required

Unique identifier of the rule.

namestring required

Human-readable name of the rule. Required and non-empty.

descriptionstring

Optional free-form description.

operationType'PowerControl' | 'FirmwareControl' required

Type of operation this rule applies to. Immutable after creation.

operationCodestring required

Operation code within the operation type (e.g. power_on, power_off, upgrade). Server-side validated against Flow's allow-list for the type. Immutable after creation.

isDefaultboolean required

Whether this rule is currently the default for its (operationType, operationCode) tuple.

createdstring date-time required

Timestamp when the rule was created.

updatedstring date-time required

Timestamp when the rule was last updated.