> 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 a Task Run POST https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/task/run Content-Type: application/json Create a Task Run: a phased, policy-gated execution of one operation across many Racks. The configuration is validated server-side by Flow; on validation failure no state changes. A Task Run executes exactly one operation (currently firmware) over a candidate set of Racks, narrowed by an optional `selector` and divided into phases by an optional `options.phasePolicy`. The response echoes the assigned `id`; the Task Run always starts in the `Pending` state. Poll `GET /task/run/{id}` for progress. 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/task-run/create-task-run ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: NVIDIA Infra Controller REST API version: 1.0.0 paths: /v2/org/{org}/nico/task/run: post: operationId: create-task-run summary: Create a Task Run description: >- Create a Task Run: a phased, policy-gated execution of one operation across many Racks. The configuration is validated server-side by Flow; on validation failure no state changes. A Task Run executes exactly one operation (currently firmware) over a candidate set of Racks, narrowed by an optional `selector` and divided into phases by an optional `options.phasePolicy`. The response echoes the assigned `id`; the Task Run always starts in the `Pending` state. Poll `GET /task/run/{id}` for progress. Org must have an Infrastructure Provider entity. User must have authorization role with `PROVIDER_ADMIN` suffix. tags: - taskRun parameters: - name: org in: path description: Name of the Org required: true schema: type: string - 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: '201': description: Task Run was created. content: application/json: schema: $ref: '#/components/schemas/TaskRun' '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/CreateTaskRunRequest' servers: - url: https://nico-rest-api.nico.svc.cluster.local description: Kubernetes Cluster components: schemas: TaskRunPercentageSelector: type: object properties: percent: type: integer description: Percentage of candidate Racks to select. seed: type: string description: Optional seed for the deterministic selection. required: - percent description: |- Selects a percentage of the candidate Racks. `seed` is optional; when omitted Flow generates and stores one so the cohort is deterministic and auditable. title: TaskRunPercentageSelector TaskRunSelector: type: object properties: percentage: $ref: '#/components/schemas/TaskRunPercentageSelector' description: >- Selects a subset of candidate Racks. Percentage is the only supported selector today. title: TaskRunSelector TaskRunFailureRateGateScope: type: string enum: - currentPhase - cumulativeRun default: currentPhase description: >- Whether the ratio is evaluated over the current phase or the cumulative run. title: TaskRunFailureRateGateScope TaskRunFailureRateGate: type: object properties: scope: $ref: '#/components/schemas/TaskRunFailureRateGateScope' default: currentPhase description: >- Whether the ratio is evaluated over the current phase or the cumulative run. thresholdPercent: type: integer description: Failure-rate percentage at which the gate trips. required: - thresholdPercent description: >- Pauses when the failed/planned ratio reaches `thresholdPercent` for the scope. title: TaskRunFailureRateGate TaskRunFailureCountGateScope: type: string enum: - currentPhase - cumulativeRun default: currentPhase description: >- Whether the count is evaluated over the current phase or the cumulative run. title: TaskRunFailureCountGateScope TaskRunFailureCountGate: type: object properties: scope: $ref: '#/components/schemas/TaskRunFailureCountGateScope' default: currentPhase description: >- Whether the count is evaluated over the current phase or the cumulative run. thresholdCount: type: integer description: Number of failed targets at which the gate trips. required: - thresholdCount description: >- Pauses when the number of failed targets reaches `thresholdCount` for the scope. title: TaskRunFailureCountGate TaskRunSafetyGate: type: object properties: failureRate: $ref: '#/components/schemas/TaskRunFailureRateGate' failureCount: $ref: '#/components/schemas/TaskRunFailureCountGate' description: Exactly one of `failureRate` or `failureCount` must be set. title: TaskRunSafetyGate TaskRunSafetyPolicy: type: object properties: gates: type: array items: $ref: '#/components/schemas/TaskRunSafetyGate' description: Safety gates evaluated after each target outcome. description: >- A set of gates that pause the Task Run when any one of them trips (OR composition). title: TaskRunSafetyPolicy TaskRunConflictRetry: type: object properties: retryTimeout: type: string description: Total time to keep retrying a blocked target before giving up. initialRetryDelay: type: string description: Delay before the first retry. maxRetryDelay: type: string description: Cap on the exponentially growing retry delay. description: |- Retry backoff for blocked targets. Durations are Go duration strings (e.g. `30m`, `10s`); an empty value means "use the operation default". title: TaskRunConflictRetry TaskRunConflictPolicy: type: object properties: retry: $ref: '#/components/schemas/TaskRunConflictRetry' description: >- Configures how blocked targets are retried. Retry is the only supported strategy today. title: TaskRunConflictPolicy TaskRunRandomOrdering: type: object properties: seed: type: string description: Optional seed for the deterministic random ordering. description: >- Orders targets randomly. `seed` is optional; Flow generates and stores one when omitted. title: TaskRunRandomOrdering TaskRunOrderingPolicy: type: object properties: random: $ref: '#/components/schemas/TaskRunRandomOrdering' description: >- Controls the order in which targets are processed. Random is the only supported ordering today. title: TaskRunOrderingPolicy TaskRunEqualPhases: type: object properties: phaseCount: type: integer description: Number of equally sized phases. required: - phaseCount description: Splits targets into `phaseCount` roughly equal phases. title: TaskRunEqualPhases TaskRunPercentagePhases: type: object properties: phases: type: array items: type: integer description: Per-phase percentages, in phase order; must sum to 100. required: - phases description: Splits targets by percentage. Values must sum to 100. title: TaskRunPercentagePhases TaskRunCountPhases: type: object properties: phases: type: array items: type: integer description: Per-phase target counts, in phase order. required: - phases description: >- Splits targets by explicit counts. A generated final phase covers any remaining targets. title: TaskRunCountPhases TaskRunPhasePolicy: type: object properties: equal: $ref: '#/components/schemas/TaskRunEqualPhases' percentage: $ref: '#/components/schemas/TaskRunPercentagePhases' count: $ref: '#/components/schemas/TaskRunCountPhases' autoAdvance: type: boolean default: false description: |- When true, phases advance automatically as long as safety gates are not tripped. When false (default) each completed phase pauses at a phase gate until advanced explicitly. description: |- Divides the selected targets into phases. Set at most one of `equal`, `percentage`, or `count`; omit the whole policy for a single phase covering all targets. title: TaskRunPhasePolicy TaskRunOptions: type: object properties: maxConcurrentTargets: type: integer description: |- Caps how many targets may have active child Tasks at once. Must be greater than zero. safetyPolicy: $ref: '#/components/schemas/TaskRunSafetyPolicy' conflictPolicy: $ref: '#/components/schemas/TaskRunConflictPolicy' orderingPolicy: $ref: '#/components/schemas/TaskRunOrderingPolicy' phasePolicy: $ref: '#/components/schemas/TaskRunPhasePolicy' required: - maxConcurrentTargets description: Execution policy for the Task Run. title: TaskRunOptions TaskRunFirmwareOperation: type: object properties: version: type: string description: Target firmware version to roll out. ruleId: type: - string - 'null' format: uuid description: |- Operation Rule to pin for each target's firmware Task. Null to let Flow's default rule resolution pick one. overrideReadinessCheck: type: boolean default: false description: Skip the pre-flight readiness check when true. subTargets: type: array items: type: string description: Optional subset of firmware sub-targets to update. required: - version description: Configures a firmware rollout. title: TaskRunFirmwareOperation TaskRunOperation: type: object properties: firmware: $ref: '#/components/schemas/TaskRunFirmwareOperation' excludeRunIds: type: array items: type: string format: uuid description: |- Excludes Racks materialized by prior Task Runs from this Task Run's candidate scope. required: - firmware description: >- The operation the Task Run executes. Firmware is the only supported operation today. title: TaskRunOperation CreateTaskRunRequest: type: object properties: siteId: type: string format: uuid description: ID of the Site to create the Task Run on. name: type: string description: Human-readable name of the Task Run. description: type: string description: Optional free-form description. selector: $ref: '#/components/schemas/TaskRunSelector' description: |- Narrows the candidate Racks. Omit to target the full candidate scope (100%). options: $ref: '#/components/schemas/TaskRunOptions' operation: $ref: '#/components/schemas/TaskRunOperation' required: - siteId - name - options - operation description: >- Request body for creating a Task Run. `operationType` is inferred from the operation and is not accepted here. Flow performs semantic validation (selector ranges, phase math, operation code membership) server-side. title: CreateTaskRunRequest TaskRunOperationType: type: string enum: - PowerControl - FirmwareControl description: >- Type of operation this Task Run executes. Currently always `FirmwareControl`. title: TaskRunOperationType TaskRunStatus: type: string enum: - Unknown - Pending - Running - Paused - Completed - Cancelled - Failed - CompletedWithFailures description: Current lifecycle state of the Task Run. title: TaskRunStatus TaskRunStatusReason: type: string enum: - Unknown - None - OperatorPaused - PhaseGate - SafetyGate - ConflictRetryTimeout description: |- Why the Task Run is paused or terminal (e.g. `PhaseGate`, `SafetyGate`). `None` when there is no qualifying reason. title: TaskRunStatusReason TaskRunOutcomeCounts: type: object properties: completed: type: integer description: Targets that completed successfully. failed: type: integer description: Targets that failed. terminated: type: integer description: Targets that were terminated (e.g. by cancellation). skipped: type: integer description: Targets that were skipped. required: - completed - failed - terminated - skipped description: Counts terminal target outcomes within a phase scope. title: TaskRunOutcomeCounts TaskRunPhaseStats: type: object properties: phaseIndex: type: integer description: Zero-based index of the phase this scope refers to. selectedTargets: type: integer description: Number of targets selected within the scope. outcomeCounts: $ref: '#/components/schemas/TaskRunOutcomeCounts' required: - phaseIndex - selectedTargets - outcomeCounts description: Summarizes target outcomes for one phase scope. title: TaskRunPhaseStats TaskRunStats: type: object properties: currentPhase: $ref: '#/components/schemas/TaskRunPhaseStats' cumulativePhase: $ref: '#/components/schemas/TaskRunPhaseStats' required: - currentPhase - cumulativePhase description: >- Summarizes target outcomes for the active phase and cumulatively across all phases processed so far. title: TaskRunStats TaskRun: type: object properties: id: type: string format: uuid description: Unique identifier of the Task Run. name: type: string description: Human-readable name of the Task Run. description: type: string description: Optional free-form description. operationType: $ref: '#/components/schemas/TaskRunOperationType' description: >- Type of operation this Task Run executes. Currently always `FirmwareControl`. operationCode: type: string description: Operation code within the operation type (e.g. `upgrade`). status: $ref: '#/components/schemas/TaskRunStatus' description: Current lifecycle state of the Task Run. statusReason: $ref: '#/components/schemas/TaskRunStatusReason' description: >- Why the Task Run is paused or terminal (e.g. `PhaseGate`, `SafetyGate`). `None` when there is no qualifying reason. statusMessage: type: string description: Optional human-readable detail for the current status. totalPhases: type: integer description: Total number of phases the selected targets were divided into. created: type: string format: date-time description: Timestamp when the Task Run was created. updated: type: string format: date-time description: Timestamp when the Task Run was last updated. started: type: - string - 'null' format: date-time description: >- Timestamp when the Task Run started execution. Null before it starts. finished: type: - string - 'null' format: date-time description: >- Timestamp when the Task Run reached a terminal state. Null while active. stats: $ref: '#/components/schemas/TaskRunStats' description: |- Derived per-phase outcome stats. Present only on the single-Task-Run `GET` when `includeStats=true`; omitted otherwise. required: - id - name - operationType - status - statusReason - totalPhases - created - updated description: |- A Task Run is a phased, policy-gated execution of one operation across many Racks. List responses populate the summary fields; the single-Task-Run `GET` additionally populates `stats` when `includeStats=true`. title: TaskRun 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": "site-1234", "name": "Firmware Update Batch 42", "options": { "maxConcurrentTargets": 5 }, "operation": { "firmware": { "version": "v2.3.1" } } } ``` **Response** ```json { "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890", "name": "Firmware Update Batch 42", "operationType": "Firmware", "status": "Pending", "statusReason": "Awaiting start", "totalPhases": 3, "created": "2024-01-15T09:30:00Z", "updated": "2024-01-15T09:30:00Z", "description": "Rolling firmware update to version v2.3.1 across selected racks", "operationCode": "FW_UPD_202406", "statusMessage": "Task run created and pending execution", "started": "2024-01-15T09:30:00Z", "finished": "2024-01-15T09:30:00Z", "stats": { "currentPhase": { "phaseIndex": 1, "selectedTargets": 10, "outcomeCounts": { "completed": 0, "failed": 0, "terminated": 0, "skipped": 0 } }, "cumulativePhase": { "phaseIndex": 1, "selectedTargets": 10, "outcomeCounts": { "completed": 0, "failed": 0, "terminated": 0, "skipped": 0 } } } } ``` **SDK Code** ```python import requests url = "https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/run" payload = { "siteId": "site-1234", "name": "Firmware Update Batch 42", "options": { "maxConcurrentTargets": 5 }, "operation": { "firmware": { "version": "v2.3.1" } } } headers = { "Authorization": "Bearer ", "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/run'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"siteId":"site-1234","name":"Firmware Update Batch 42","options":{"maxConcurrentTargets":5},"operation":{"firmware":{"version":"v2.3.1"}}}' }; 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/run" payload := strings.NewReader("{\n \"siteId\": \"site-1234\",\n \"name\": \"Firmware Update Batch 42\",\n \"options\": {\n \"maxConcurrentTargets\": 5\n },\n \"operation\": {\n \"firmware\": {\n \"version\": \"v2.3.1\"\n }\n }\n}") req, _ := http.NewRequest("POST", 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/run") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"siteId\": \"site-1234\",\n \"name\": \"Firmware Update Batch 42\",\n \"options\": {\n \"maxConcurrentTargets\": 5\n },\n \"operation\": {\n \"firmware\": {\n \"version\": \"v2.3.1\"\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.post("https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/run") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"siteId\": \"site-1234\",\n \"name\": \"Firmware Update Batch 42\",\n \"options\": {\n \"maxConcurrentTargets\": 5\n },\n \"operation\": {\n \"firmware\": {\n \"version\": \"v2.3.1\"\n }\n }\n}") .asString(); ``` ```php request('POST', 'https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/task/run', [ 'body' => '{ "siteId": "site-1234", "name": "Firmware Update Batch 42", "options": { "maxConcurrentTargets": 5 }, "operation": { "firmware": { "version": "v2.3.1" } } }', '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/run"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"siteId\": \"site-1234\",\n \"name\": \"Firmware Update Batch 42\",\n \"options\": {\n \"maxConcurrentTargets\": 5\n },\n \"operation\": {\n \"firmware\": {\n \"version\": \"v2.3.1\"\n }\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "siteId": "site-1234", "name": "Firmware Update Batch 42", "options": ["maxConcurrentTargets": 5], "operation": ["firmware": ["version": "v2.3.1"]] ] 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/run")! 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() ```