> ## Documentation Index > Fetch the complete documentation index at: https://orbit.nckrtl.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Cancel a todo or running subtask > Cancels a `todo` or `running` subtask. A `todo` subtask may be cancelled when its group is `todo`, `running`, `reviewing`, `settling`, or `waiting_for_review`; this marks it cancelled with `settled_at`, starts nothing, and requests no assistance. If no open subtask remains, including reserved, running, or reviewing siblings, the group moves to `settling`. Cancelling a `running` subtask stops its implementer and its running baseline or handoff check, keeps the group and its Instance, and starts the lowest-position `todo` subtask. That subtask runs the baseline check first when no implementer has started in the group. The group settles only when no open subtask remains. Requires Gateway access. Returns `extension.disabled` while the extension is off, `tasks.subtask_not_running` (409) when the subtask is neither cancellable `todo` nor `running`, and `tasks.subtask_interrupt_failed` (502) when a running subtask implementer or check could not be stopped; the subtask then stays `running`. ## OpenAPI ````yaml /openapi.json post /api/v1/task-groups/{group}/tasks/{task}/cancel openapi: 3.1.0 info: title: Orbit Gateway API version: v1 description: >- The HTTP API of the active Orbit Gateway. The CLI and the PHP SDK send every fleet command through these endpoints over WireGuard. See [Using the API](/api/overview) for transport, authentication, envelopes, and errors. servers: - url: https://gateway.orbit description: >- The active Gateway on the private WireGuard network, resolved by Orbit private DNS. security: [] tags: - name: Gateway description: >- Status and trust of the active Gateway, and the releases of the Gateway itself. - name: Nodes description: Machines in the fleet, their roles, access grants, and storage settings. - name: Clusters description: Groups of Nodes with one Router and one development TLD. - name: Firewall description: Named UFW rules on one Node. - name: Fleet rollout description: >- The rollout of each verified Gateway release to the managed Nodes, and its catch-up. - name: Tools description: Packages that Orbit installs on a Node through a Tool Manager. - name: Metrics description: The Prometheus and Grafana role and its exporters. - name: GitHub App description: The Gateway's own read-only GitHub App and the accounts that installed it. - name: Analytics description: >- The analytics role, its Plausible version, and the Stats API key the Gateway uses to read visits. - name: Projects description: Repository records with one type, default branch, and web root each. - name: Instances description: Development checkouts and production releases of a Project on one Node. - name: Environment description: Stored Instance environment configuration and its .env projection. - name: Routes description: Domains that reach an Instance. - name: Database connections description: The registry of mysql, pgsql, and sqlite connections. - name: Processes description: >- systemd services and Docker containers owned by an Instance, a Node, or a Project definition. - name: Schedules description: Recurring commands run by native systemd timers. - name: Annotations description: Instance annotations, T3 delivery, and replayable status events. - name: Tasks description: Commander feature groups and ordered subtasks. - name: Extensions description: Gateway-owned extension switches. - name: Doctor description: Verify-only drift checks across the fleet. - name: Activities description: The Gateway log of authorized commands. - name: proxycli description: CLIProxyAPI quota snapshots, provider pools, and account controls. - name: Vaultwarden description: The copy of database credentials into a Vaultwarden collection. - name: Conn description: >- Profiles, shared workspace settings, registered T3 servers, and the pairing links the Gateway mints on them for each Node. - name: Realtime description: >- The record-change event feed broadcast to Reverb, its channel authorization, and Reverb connection discovery. - name: Node callbacks description: Endpoints that managed Nodes and Caddy call; operators do not call them. paths: /api/v1/task-groups/{group}/tasks/{task}/cancel: post: tags: - Tasks summary: Cancel a todo or running subtask description: >- Cancels a `todo` or `running` subtask. A `todo` subtask may be cancelled when its group is `todo`, `running`, `reviewing`, `settling`, or `waiting_for_review`; this marks it cancelled with `settled_at`, starts nothing, and requests no assistance. If no open subtask remains, including reserved, running, or reviewing siblings, the group moves to `settling`. Cancelling a `running` subtask stops its implementer and its running baseline or handoff check, keeps the group and its Instance, and starts the lowest-position `todo` subtask. That subtask runs the baseline check first when no implementer has started in the group. The group settles only when no open subtask remains. Requires Gateway access. Returns `extension.disabled` while the extension is off, `tasks.subtask_not_running` (409) when the subtask is neither cancellable `todo` nor `running`, and `tasks.subtask_interrupt_failed` (502) when a running subtask implementer or check could not be stopped; the subtask then stays `running`. operationId: tasks-subtask-cancel parameters: - name: group in: path required: true schema: type: integer minimum: 1 description: Numeric Task group ID. - name: task in: path required: true schema: type: string description: '' requestBody: required: false content: application/json: schema: type: object additionalProperties: false responses: '200': description: The request succeeded. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Task' meta: $ref: '#/components/schemas/Meta' required: - data - meta '403': description: >- The caller is not an active WireGuard peer (`peer.identity_unknown`) or lacks Node access to the target (`node_access.required`). content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: No record matches the path parameters. content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: >- The tasks extension is disabled (`extension.disabled`) or the subtask is not running (`tasks.subtask_not_running`). A disabled extension returns HTTP 409 (`extension.disabled`). content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: >- The JSON body is not an object, has duplicate or unknown members, or fails validation (`validation.failed`). content: application/json: schema: $ref: '#/components/schemas/Error' '502': description: >- The implementer or the running check could not be stopped (`tasks.subtask_interrupt_failed`). The subtask stays running. content: application/json: schema: $ref: '#/components/schemas/Error' x-codeSamples: - lang: bash label: curl source: > curl -sS -X POST "https://gateway.orbit/api/v1/task-groups/1/tasks/1/cancel" \ --cacert /path/to/orbit-root-ca.pem \ -H 'Accept: application/json' \ -H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81' \ -H 'Content-Type: application/json' \ -d '{}' - lang: php label: PHP SDK source: > send(new CancelSubtaskRequest(groupId: 1, taskId: 1))->dto(); components: schemas: Task: type: object properties: id: type: integer task_group_id: type: integer position: type: integer title: type: string brief: type: string deliverables: type: array items: type: object topology: type: array items: type: string status: type: string enum: - todo - reserved - running - reviewing - completed - failed - cancelled implementer_agent_thread_id: type: - integer - 'null' tokens: type: - integer - 'null' line_diff: type: - integer - 'null' lines_added: type: - integer - 'null' lines_deleted: type: - integer - 'null' duration_ms: type: - integer - 'null' questions: type: integer escalations: type: integer type: type: string enum: - implementation - annotation - final_review target_thread_id: type: - string - 'null' completion_summary: type: - string - 'null' check: oneOf: - $ref: '#/components/schemas/TaskCheck' - type: 'null' assistance_requested: type: boolean assistance_kind: type: - string - 'null' enum: - direction - failure - null assistance_question: type: - string - 'null' assistance_reason: type: - string - 'null' fixup_problem: type: - string - 'null' Meta: type: object properties: request_id: type: string format: uuid description: >- The request ID the Gateway assigned or accepted; the same value is in the `X-Orbit-Request-Id` response header and in the Activity record. required: - request_id Error: type: object properties: error: type: object properties: code: type: string description: >- Stable error code, namespaced by family, such as `node.not_active` or `route.target_conflict`. message: type: string description: >- Safe message without credentials, environment values, or remote output. details: type: object additionalProperties: true description: >- Bounded, redacted details such as the conflicting record IDs or the failed validation rule. request_id: type: string format: uuid required: - code - message required: - error TaskCheck: type: object properties: id: type: integer kind: type: string enum: - baseline - handoff status: type: string enum: - running - passed - failed - changed - lost - cancelled started_at: type: string finished_at: type: - string - 'null' exit_code: type: - integer - 'null' changed_paths: type: array items: type: string failed_step: type: - string - 'null' output: type: - string - 'null' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.