Update an Operation Rule

PATCH

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/task/rule/:id

PATCH

/v2/org/:org/nico/task/rule/:id

$ curl -X PATCH https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/rule/id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
>   "name": "Power On Sequence",
>   "description": "Rule to power on all compute nodes in sequence with verification steps.",
>   "ruleDefinition": {
>     "version": "v1",
>     "steps": [
>       {
>         "componentType": "Compute",
>         "stage": 1,
>         "mainOperation": {
>           "name": "PowerControl",
>           "timeout": "2m",
>           "parameters": {
>             "operation": "on"
>           }
>         },
>         "maxParallel": 2,
>         "timeout": "5m",
>         "retry": {
>           "maxAttempts": 3,
>           "initialInterval": "10s",
>           "backoffCoefficient": 2,
>           "maxInterval": "1m"
>         },
>         "preOperation": [
>           {
>             "name": "VerifyPowerStatus",
>             "timeout": "30s",
>             "parameters": {
>               "expected_status": "off"
>             }
>           }
>         ],
>         "postOperation": [
>           {
>             "name": "VerifyPowerStatus",
>             "timeout": "1m",
>             "parameters": {
>               "expected_status": "on"
>             }
>           }
>         ]
>       }
>     ]
>   }
> }'

1 {}

Patch the mutable fields of an Operation Rule: name, description, and ruleDefinition. Unset fields are left unchanged. The rule definition is re-validated server-side; validation failure leaves the rule untouched.

operationType and operationCode are immutable after creation — create a new rule and delete the old one to change them.

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

Patch the mutable fields of an Operation Rule: `name`, `description`, and `ruleDefinition`. Unset fields are left unchanged. The rule definition is re-validated server-side; validation failure leaves the rule untouched. `operationType` and `operationCode` are immutable after creation — create a new rule and delete the old one to change them. Org must have an Infrastructure Provider entity. User must have authorization role with `PROVIDER_ADMIN` suffix.

Authentication

AuthorizationBearer

export JWT_BEARER_TOKEN="<jwt-bearer-token>"
# Example org name: "acme-inc
export ORG_NAME=<org-name>
# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired

Name of the Org

idstringRequiredformat: "uuid"

UUID of the Rule

Request

This endpoint expects an object.

siteIdstringRequiredformat: "uuid"

ID of the Site that owns the rule.

namestringOptional

New rule name. Must be non-empty when provided.

descriptionstringOptional

New free-form description.

ruleDefinitionobjectOptional

Executable definition of a rule. Mirrors Flow’s wire schema 1:1 so existing YAML rule files can be converted to JSON without any key renaming (nested fields use snake_case).

Response

Rule was updated.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error