> 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. # Update an Operation Rule PATCH https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/task/rule/{id} Content-Type: application/json 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. Reference: https://docs.nvidia.com/infra-controller/infra-controller/rest-api-reference/api-reference/rule/update-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/{id}: patch: operationId: update-rule summary: Update an Operation Rule description: >- 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. tags: - subpackage_rule parameters: - name: org in: path description: Name of the Org required: true schema: type: string - name: id in: path description: UUID of the Rule required: true schema: type: string format: uuid - name: Authorization in: header description: >- ``` export JWT_BEARER_TOKEN="" # Example org name: "acme-inc export 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: '204': description: Rule was updated. content: application/json: schema: type: object properties: {} '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' '404': description: Error response when requested object is not found content: application/json: schema: $ref: '#/components/schemas/NICoAPIError' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRuleRequest' servers: - url: https://nico-rest-api.nico.svc.cluster.local description: Kubernetes Cluster components: schemas: 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 UpdateRuleRequest: type: object properties: siteId: type: string format: uuid description: ID of the Site that owns the rule. name: type: string description: New rule name. Must be non-empty when provided. description: type: string description: New free-form description. ruleDefinition: $ref: '#/components/schemas/RuleDefinition' required: - siteId description: >- Request body for patching an Operation Rule. All mutable fields are optional; unset fields are left unchanged. At least one of `name`, `description`, `ruleDefinition` must be provided. title: UpdateRuleRequest 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="" # Example org name: "acme-inc export 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": "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" } } ] } ] } } ``` **Response** ```json {} ``` **SDK Code** ```python import requests url = "https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/rule/id" payload = { "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" } } ] } ] } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(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/id'; const options = { method: 'PATCH', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"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"}}]}]}}' }; 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/id" payload := strings.NewReader("{\n \"siteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"Power On Sequence\",\n \"description\": \"Rule to power on all compute nodes in sequence with verification steps.\",\n \"ruleDefinition\": {\n \"version\": \"v1\",\n \"steps\": [\n {\n \"componentType\": \"Compute\",\n \"stage\": 1,\n \"mainOperation\": {\n \"name\": \"PowerControl\",\n \"timeout\": \"2m\",\n \"parameters\": {\n \"operation\": \"on\"\n }\n },\n \"maxParallel\": 2,\n \"timeout\": \"5m\",\n \"retry\": {\n \"maxAttempts\": 3,\n \"initialInterval\": \"10s\",\n \"backoffCoefficient\": 2,\n \"maxInterval\": \"1m\"\n },\n \"preOperation\": [\n {\n \"name\": \"VerifyPowerStatus\",\n \"timeout\": \"30s\",\n \"parameters\": {\n \"expected_status\": \"off\"\n }\n }\n ],\n \"postOperation\": [\n {\n \"name\": \"VerifyPowerStatus\",\n \"timeout\": \"1m\",\n \"parameters\": {\n \"expected_status\": \"on\"\n }\n }\n ]\n }\n ]\n }\n}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("Authorization", "Bearer ") 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/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"siteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"Power On Sequence\",\n \"description\": \"Rule to power on all compute nodes in sequence with verification steps.\",\n \"ruleDefinition\": {\n \"version\": \"v1\",\n \"steps\": [\n {\n \"componentType\": \"Compute\",\n \"stage\": 1,\n \"mainOperation\": {\n \"name\": \"PowerControl\",\n \"timeout\": \"2m\",\n \"parameters\": {\n \"operation\": \"on\"\n }\n },\n \"maxParallel\": 2,\n \"timeout\": \"5m\",\n \"retry\": {\n \"maxAttempts\": 3,\n \"initialInterval\": \"10s\",\n \"backoffCoefficient\": 2,\n \"maxInterval\": \"1m\"\n },\n \"preOperation\": [\n {\n \"name\": \"VerifyPowerStatus\",\n \"timeout\": \"30s\",\n \"parameters\": {\n \"expected_status\": \"off\"\n }\n }\n ],\n \"postOperation\": [\n {\n \"name\": \"VerifyPowerStatus\",\n \"timeout\": \"1m\",\n \"parameters\": {\n \"expected_status\": \"on\"\n }\n }\n ]\n }\n ]\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/rule/id") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"siteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"Power On Sequence\",\n \"description\": \"Rule to power on all compute nodes in sequence with verification steps.\",\n \"ruleDefinition\": {\n \"version\": \"v1\",\n \"steps\": [\n {\n \"componentType\": \"Compute\",\n \"stage\": 1,\n \"mainOperation\": {\n \"name\": \"PowerControl\",\n \"timeout\": \"2m\",\n \"parameters\": {\n \"operation\": \"on\"\n }\n },\n \"maxParallel\": 2,\n \"timeout\": \"5m\",\n \"retry\": {\n \"maxAttempts\": 3,\n \"initialInterval\": \"10s\",\n \"backoffCoefficient\": 2,\n \"maxInterval\": \"1m\"\n },\n \"preOperation\": [\n {\n \"name\": \"VerifyPowerStatus\",\n \"timeout\": \"30s\",\n \"parameters\": {\n \"expected_status\": \"off\"\n }\n }\n ],\n \"postOperation\": [\n {\n \"name\": \"VerifyPowerStatus\",\n \"timeout\": \"1m\",\n \"parameters\": {\n \"expected_status\": \"on\"\n }\n }\n ]\n }\n ]\n }\n}") .asString(); ``` ```php request('PATCH', 'https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/rule/id', [ 'body' => '{ "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" } } ] } ] } }', 'headers' => [ 'Authorization' => 'Bearer ', '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/id"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"siteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"Power On Sequence\",\n \"description\": \"Rule to power on all compute nodes in sequence with verification steps.\",\n \"ruleDefinition\": {\n \"version\": \"v1\",\n \"steps\": [\n {\n \"componentType\": \"Compute\",\n \"stage\": 1,\n \"mainOperation\": {\n \"name\": \"PowerControl\",\n \"timeout\": \"2m\",\n \"parameters\": {\n \"operation\": \"on\"\n }\n },\n \"maxParallel\": 2,\n \"timeout\": \"5m\",\n \"retry\": {\n \"maxAttempts\": 3,\n \"initialInterval\": \"10s\",\n \"backoffCoefficient\": 2,\n \"maxInterval\": \"1m\"\n },\n \"preOperation\": [\n {\n \"name\": \"VerifyPowerStatus\",\n \"timeout\": \"30s\",\n \"parameters\": {\n \"expected_status\": \"off\"\n }\n }\n ],\n \"postOperation\": [\n {\n \"name\": \"VerifyPowerStatus\",\n \"timeout\": \"1m\",\n \"parameters\": {\n \"expected_status\": \"on\"\n }\n }\n ]\n }\n ]\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "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"] ] ] ] ] ] ] 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/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" 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() ```