> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/infra-controller/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/infra-controller/_mcp/server.

# Create an Operation Rule

POST https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/task/rule
Content-Type: application/json

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.

Reference: https://docs.nvidia.com/infra-controller/infra-controller/rest-api-reference/api-reference/rule/create-rule

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: NVIDIA Infra Controller REST API
  version: 1.0.0
paths:
  /v2/org/{org}/nico/task/rule:
    post:
      operationId: create-rule
      summary: Create an Operation Rule
      description: >-
        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.
      tags:
        - subpackage_rule
      parameters:
        - name: org
          in: path
          description: Name of the Org
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            ```

            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

            ```
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Rule was created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationRule'
        '400':
          description: Error response when request data cannot be validated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NICoAPIError'
        '403':
          description: >-
            Error response when user is not authorized to call an endpoint or
            retrieve/modify objects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NICoAPIError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRuleRequest'
servers:
  - url: https://nico-rest-api.nico.svc.cluster.local
    description: Kubernetes Cluster
components:
  schemas:
    CreateRuleRequestOperationType:
      type: string
      enum:
        - PowerControl
        - FirmwareControl
      description: Operation type the rule applies to.
      title: CreateRuleRequestOperationType
    RuleDefinitionVersion:
      type: string
      enum:
        - v1
      description: Schema version. Currently always `v1`.
      title: RuleDefinitionVersion
    RetryPolicy:
      type: object
      properties:
        maxAttempts:
          type: integer
          description: Maximum number of attempts including the first.
        initialInterval:
          type: string
          description: Initial retry interval, as a Go duration string (e.g. `1s`).
        backoffCoefficient:
          type: number
          format: double
          description: Exponential backoff multiplier; must be `>= 1.0`.
        maxInterval:
          type: string
          description: Optional cap on retry interval, as a Go duration string.
      required:
        - maxAttempts
        - initialInterval
        - backoffCoefficient
      description: Retry behavior for a step's child workflow.
      title: RetryPolicy
    ActionConfigName:
      type: string
      enum:
        - Sleep
        - PowerControl
        - VerifyPowerStatus
        - VerifyReachability
        - GetPowerStatus
        - FirmwareControl
        - VerifyFirmwareVersion
        - VerifyFirmwareConsistency
        - BringUpControl
        - WaitBringUp
        - InjectExpectation
      description: |-
        Executor-agnostic action name. Server-side validated; unknown names
        fail the rule definition.
      title: ActionConfigName
    ActionConfig:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/ActionConfigName'
          description: |-
            Executor-agnostic action name. Server-side validated; unknown names
            fail the rule definition.
        timeout:
          type: string
          description: |-
            Optional per-action timeout override as a Go duration string
            (e.g. `30s`, `2m`).
        pollInterval:
          type: string
          description: |-
            Poll interval for actions that loop (e.g. `FirmwareControl`,
            `VerifyPowerStatus`) as a Go duration string.
        parameters:
          type: object
          additionalProperties:
            description: Any type
          description: >-
            Action-specific parameters. Validated server-side against the
            action's

            schema. Examples:
              - `Sleep`: `{ duration: "30s" }`
              - `PowerControl`: `{ operation: "on" }`
              - `VerifyPowerStatus`: `{ expected_status: "on" }`
              - `VerifyReachability`: `{ component_types: ["Compute"], require_all: true }`
              - `FirmwareControl`: `{ poll_interval: "10s", poll_timeout: "30m" }`
      required:
        - name
      description: Configuration for a single action within a step.
      title: ActionConfig
    SequenceStep:
      type: object
      properties:
        componentType:
          type: string
          description: |-
            Component type this step targets (e.g. `Compute`, `NVLSwitch`,
            `PowerShelf`). Validated against Flow's component-type set.
        stage:
          type: integer
          description: >-
            Stage number; steps with the same stage run in parallel, lower
            stages run

            first. Component types must be unique within a stage.
        maxParallel:
          type: integer
          description: >-
            Maximum number of components of this type processed concurrently.
            `0`

            means unlimited, `1` means strictly sequential.
        timeout:
          type: string
          description: >-
            Optional child-workflow timeout for this step, as a Go duration
            string

            (e.g. `30s`, `2m`). Applies to pre + main + post combined.
        retry:
          $ref: '#/components/schemas/RetryPolicy'
        preOperation:
          type: array
          items:
            $ref: '#/components/schemas/ActionConfig'
          description: Actions to run before the main operation.
        mainOperation:
          $ref: '#/components/schemas/ActionConfig'
        postOperation:
          type: array
          items:
            $ref: '#/components/schemas/ActionConfig'
          description: Actions to run after the main operation.
        delayAfter:
          type: string
          description: |-
            Deprecated legacy field — sleep duration after this step, as a Go
            duration string. Prefer encoding the wait as an explicit `Sleep`
            post-operation action.
      required:
        - componentType
        - stage
        - mainOperation
      description: A single execution step inside a `RuleDefinition`.
      title: SequenceStep
    RuleDefinition:
      type: object
      properties:
        version:
          $ref: '#/components/schemas/RuleDefinitionVersion'
          description: Schema version. Currently always `v1`.
        steps:
          type: array
          items:
            $ref: '#/components/schemas/SequenceStep'
          description: >-
            Ordered execution steps. Steps with the same `stage` run in
            parallel,

            stages run sequentially in ascending numerical order. May be empty
            for

            operations whose sequencing is hardcoded in Flow (e.g. bring-up,

            firmware update).
      required:
        - version
      description: >-
        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`).
      title: RuleDefinition
    CreateRuleRequest:
      type: object
      properties:
        siteId:
          type: string
          format: uuid
          description: ID of the Site to create the rule on.
        name:
          type: string
          description: Human-readable name of the rule.
        description:
          type: string
          description: Optional free-form description.
        operationType:
          $ref: '#/components/schemas/CreateRuleRequestOperationType'
          description: Operation type the rule applies to.
        operationCode:
          type: string
          description: Operation code within the operation type (e.g. `power_on`).
        ruleDefinition:
          $ref: '#/components/schemas/RuleDefinition'
      required:
        - siteId
        - name
        - operationType
        - operationCode
        - ruleDefinition
      description: Request body for creating an Operation Rule.
      title: CreateRuleRequest
    OperationRuleOperationType:
      type: string
      enum:
        - PowerControl
        - FirmwareControl
      description: Type of operation this rule applies to. Immutable after creation.
      title: OperationRuleOperationType
    OperationRule:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the rule.
        name:
          type: string
          description: Human-readable name of the rule. Required and non-empty.
        description:
          type: string
          description: Optional free-form description.
        operationType:
          $ref: '#/components/schemas/OperationRuleOperationType'
          description: Type of operation this rule applies to. Immutable after creation.
        operationCode:
          type: string
          description: >-
            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.
        ruleDefinition:
          $ref: '#/components/schemas/RuleDefinition'
        isDefault:
          type: boolean
          description: |-
            Whether this rule is currently the default for its `(operationType,
            operationCode)` tuple.
        created:
          type: string
          format: date-time
          description: Timestamp when the rule was created.
        updated:
          type: string
          format: date-time
          description: Timestamp when the rule was last updated.
      required:
        - id
        - name
        - operationType
        - operationCode
        - ruleDefinition
        - isDefault
        - created
        - updated
      description: >-
        An Operation Rule template for a single (operationType, operationCode)
        tuple.

        The `ruleDefinition` carries the executable schedule (stages,
        per-component

        concurrency, actions, retry) Flow runs when this rule is selected for an

        operation.
      title: OperationRule
    NiCoApiErrorSource:
      type: string
      enum:
        - nico
      description: Source of the error.
      title: NiCoApiErrorSource
    NiCoApiErrorData:
      type: object
      properties: {}
      description: Additional data about the error
      title: NiCoApiErrorData
    NICoAPIError:
      type: object
      properties:
        source:
          $ref: '#/components/schemas/NiCoApiErrorSource'
          description: Source of the error.
        message:
          type: string
          description: Message describing the error
        data:
          oneOf:
            - $ref: '#/components/schemas/NiCoApiErrorData'
            - type: 'null'
          description: Additional data about the error
      description: Describes the error response from NVIDIA Infra Controller REST API
      title: NICoAPIError
  securitySchemes:
    JWTBearerToken:
      type: http
      scheme: bearer
      description: >-
        ```

        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

        ```

```

## Examples



**Request**

```json
{
  "siteId": "site-1234",
  "name": "Power Cycle Rule",
  "operationType": "power_control",
  "operationCode": "power_cycle",
  "ruleDefinition": {
    "version": "v1"
  }
}
```

**Response**

```json
{
  "id": "rule-5678",
  "name": "Power Cycle Rule",
  "operationType": "power_control",
  "operationCode": "power_cycle",
  "ruleDefinition": {
    "version": "v1",
    "steps": [
      {
        "stage": 1,
        "timeout": "5m",
        "retry": {
          "max_attempts": 3,
          "initial_interval": "30s",
          "backoff_coefficient": 2,
          "max_interval": "2m"
        },
        "component_type": "power_module",
        "max_parallel": 2,
        "pre_operation": [
          {
            "name": "CheckPowerStatus",
            "timeout": "1m",
            "poll_interval": "10s",
            "parameters": {}
          }
        ],
        "main_operation": {
          "name": "PowerOff",
          "timeout": "2m",
          "poll_interval": "15s",
          "parameters": {}
        },
        "post_operation": [
          {
            "name": "PowerOn",
            "timeout": "3m",
            "poll_interval": "20s",
            "parameters": {}
          }
        ],
        "delay_after": "30s"
      }
    ]
  },
  "isDefault": true,
  "created": "2024-01-15T09:30:00Z",
  "updated": "2024-01-15T09:30:00Z",
  "description": "Rule to perform a power cycle operation on the device"
}
```

**SDK Code**

```python
import requests

url = "https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/rule"

payload = {
    "siteId": "site-1234",
    "name": "Power Cycle Rule",
    "operationType": "power_control",
    "operationCode": "power_cycle",
    "ruleDefinition": { "version": "v1" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/rule';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"siteId":"site-1234","name":"Power Cycle Rule","operationType":"power_control","operationCode":"power_cycle","ruleDefinition":{"version":"v1"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/rule"

	payload := strings.NewReader("{\n  \"siteId\": \"site-1234\",\n  \"name\": \"Power Cycle Rule\",\n  \"operationType\": \"power_control\",\n  \"operationCode\": \"power_cycle\",\n  \"ruleDefinition\": {\n    \"version\": \"v1\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/rule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"siteId\": \"site-1234\",\n  \"name\": \"Power Cycle Rule\",\n  \"operationType\": \"power_control\",\n  \"operationCode\": \"power_cycle\",\n  \"ruleDefinition\": {\n    \"version\": \"v1\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/rule")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"siteId\": \"site-1234\",\n  \"name\": \"Power Cycle Rule\",\n  \"operationType\": \"power_control\",\n  \"operationCode\": \"power_cycle\",\n  \"ruleDefinition\": {\n    \"version\": \"v1\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/rule', [
  'body' => '{
  "siteId": "site-1234",
  "name": "Power Cycle Rule",
  "operationType": "power_control",
  "operationCode": "power_cycle",
  "ruleDefinition": {
    "version": "v1"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/rule");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"siteId\": \"site-1234\",\n  \"name\": \"Power Cycle Rule\",\n  \"operationType\": \"power_control\",\n  \"operationCode\": \"power_cycle\",\n  \"ruleDefinition\": {\n    \"version\": \"v1\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "siteId": "site-1234",
  "name": "Power Cycle Rule",
  "operationType": "power_control",
  "operationCode": "power_cycle",
  "ruleDefinition": ["version": "v1"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/rule")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```