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

# Cancel a Task Run

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

Cancel a Task Run. Best-effort cancellation cascades to the current
phase's in-flight target Tasks; targets not yet claimed are not started.
Cancelling an already-terminal Task Run returns its last known state.

Task Runs are site-scoped; `siteId` must be the Site that owns the
Task Run. 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/cancel-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/{id}/cancel:
    post:
      operationId: cancel-task-run
      summary: Cancel a Task Run
      description: >-
        Cancel a Task Run. Best-effort cancellation cascades to the current

        phase's in-flight target Tasks; targets not yet claimed are not started.

        Cancelling an already-terminal Task Run returns its last known state.


        Task Runs are site-scoped; `siteId` must be the Site that owns the

        Task Run. 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: id
          in: path
          description: UUID of the Task Run
          required: true
          schema:
            type: string
            format: uuid
        - 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:
        '202':
          description: |-
            Accepted. The cancellation request was accepted and the Task Run's
            last known state is returned.
          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'
        '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/CancelTaskRunRequest'
servers:
  - url: https://nico-rest-api.nico.svc.cluster.local
    description: Kubernetes Cluster
components:
  schemas:
    CancelTaskRunRequest:
      type: object
      properties:
        siteId:
          type: string
          format: uuid
          description: ID of the Site that owns the Task Run.
        reason:
          type: string
          description: Optional free-form reason recorded with the cancellation.
      required:
        - siteId
      description: Request body for cancelling a Task Run.
      title: CancelTaskRunRequest
    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="<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": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

**Response**

```json
{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "name": "Firmware Upgrade Batch 42",
  "operationType": "FirmwareControl",
  "status": "Cancelled",
  "statusReason": "OperatorPaused",
  "totalPhases": 3,
  "created": "2024-01-15T09:30:00Z",
  "updated": "2024-01-15T10:15:00Z",
  "description": "Cancelling the ongoing firmware upgrade task run for site 3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "operationCode": "upgrade",
  "statusMessage": "Task run cancellation requested by operator; in-flight targets are being terminated.",
  "started": "2024-01-15T09:45:00Z",
  "finished": "2024-01-15T10:15:00Z",
  "stats": {
    "currentPhase": {
      "phaseIndex": 2,
      "selectedTargets": 50,
      "outcomeCounts": {
        "completed": 30,
        "failed": 5,
        "terminated": 10,
        "skipped": 5
      }
    },
    "cumulativePhase": {
      "phaseIndex": 2,
      "selectedTargets": 150,
      "outcomeCounts": {
        "completed": 120,
        "failed": 10,
        "terminated": 15,
        "skipped": 5
      }
    }
  }
}
```

**SDK Code**

```python
import requests

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

payload = { "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }
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/run/id/cancel';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"siteId":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}'
};

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/id/cancel"

	payload := strings.NewReader("{\n  \"siteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\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/run/id/cancel")

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\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\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/run/id/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"siteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\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/run/id/cancel', [
  'body' => '{
  "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}',
  '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/run/id/cancel");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"siteId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"] 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/id/cancel")! 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()
```