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>" \
>      -H "Content-Type: application/json" \
>      -d siteId=siteId

1 {
2   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3   "name": "Standard Power On Sequence",
4   "operationType": "PowerControl",
5   "operationCode": "power_on",
6   "ruleDefinition": {
7     "version": "v1",
8     "steps": [
9       {
10         "componentType": "Compute",
11         "stage": 1,
12         "mainOperation": {
13           "name": "PowerControl",
14           "timeout": "1m",
15           "pollInterval": "10s",
16           "parameters": {
17             "operation": "on"
18           }
19         },
20         "maxParallel": 2,
21         "timeout": "2m",
22         "retry": {
23           "maxAttempts": 3,
24           "initialInterval": "10s",
25           "backoffCoefficient": 2,
26           "maxInterval": "1m"
27         },
28         "preOperation": [
29           {
30             "name": "VerifyReachability",
31             "timeout": "30s",
32             "pollInterval": "5s",
33             "parameters": {
34               "component_types": [
35                 "Compute"
36               ],
37               "require_all": true
38             }
39           }
40         ],
41         "postOperation": [
42           {
43             "name": "VerifyPowerStatus",
44             "timeout": "1m",
45             "pollInterval": "10s",
46             "parameters": {
47               "expected_status": "on"
48             }
49           }
50         ],
51         "delayAfter": "15s"
52       }
53     ]
54   },
55   "isDefault": true,
56   "created": "2024-01-15T09:30:00Z",
57   "updated": "2024-01-15T09:30:00Z",
58   "description": "Rule to power on compute nodes with verification steps"
59 }

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 (e.g. power_on, power_off, upgrade). Server-side validated against Flow’s allow-list for the type. Immutable after creation.

ruleDefinitionobject

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).

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.

descriptionstring

Optional free-form description.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error