Retrieve an Operation Rule

GET

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

GET

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

curl -G https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/rule/id \
     -H "Authorization: Bearer <token>" \
     -d siteId=siteId

{
  "id": "2c9f4a1b-7d38-4e52-9b6c-1a0d3e5f7b92",
  "name": "Power on - shelves, then switches, then compute",
  "operationType": "PowerControl",
  "operationCode": "power_on",
  "ruleDefinition": {
    "version": "v1",
    "steps": [
      {
        "componentType": "PowerShelf",
        "stage": 1,
        "mainOperation": {
          "name": "PowerControl"
        },
        "maxParallel": 0,
        "timeout": "15m",
        "retry": {
          "maxAttempts": 3,
          "initialInterval": "5s",
          "backoffCoefficient": 2,
          "maxInterval": "1m"
        },
        "postOperation": [
          {
            "name": "VerifyPowerStatus",
            "timeout": "5m",
            "pollInterval": "10s",
            "parameters": {
              "expected_status": "on"
            }
          }
        ]
      },
      {
        "componentType": "Compute",
        "stage": 2,
        "mainOperation": {
          "name": "PowerControl"
        },
        "maxParallel": 8,
        "timeout": "20m",
        "retry": {
          "maxAttempts": 3,
          "initialInterval": "1s",
          "backoffCoefficient": 2
        },
        "postOperation": [
          {
            "name": "VerifyReachability",
            "timeout": "10m",
            "pollInterval": "30s",
            "parameters": {
              "component_types": [
                "Compute"
              ],
              "require_all": true
            }
          }
        ]
      }
    ]
  },
  "isDefault": true,
  "created": "2026-07-02T09:14:37Z",
  "updated": "2026-08-05T11:20:05Z",
  "description": "Verifies each component type reached the on state before the next stage starts."
}

Get an Operation Rule by UUID.

Rules are site-scoped; siteId must be the Site that owns the rule. 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

Query parameters

siteIdstringRequiredformat: "uuid"

ID of the Site that owns the rule (rules are site-scoped).

Response

idstringformat: "uuid"

Unique identifier of the rule.

namestring

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

operationTypeenum

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

operationCodestring

Operation code within the operation type. For PowerControl, accepted values are power_on, force_power_on, power_off, force_power_off, restart, force_restart, warm_reset, and cold_reset. For FirmwareControl, accepted values are upgrade, downgrade, and rollback. The server validates the code against the selected type. Immutable after creation.

ruleDefinitionobject

Executable definition of a rule. Structurally identical to Flow’s own rule schema, so an existing YAML rule file maps across field for field. The fields declared here use camelCase (componentType, mainOperation, pollInterval) rather than the snake_case of Flow’s YAML; keys inside the free-form parameters map pass through unchanged and stay snake_case (expected_status, component_types).

isDefaultboolean

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

createddatetime

Timestamp when the rule was created.

updateddatetime

Timestamp when the rule was last updated.

descriptionstringOptional

Optional free-form description.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

504

Gateway Timeout Error