dots.v2.agents.sessions.bySession_id().workspace.transfers.byTransfer_id().cancel.post()
Generated on 13 Nov 2026
from DoTs version
v1.24.0
Usage
client.v2.agents.sessions.bySession_id(session_id).workspace.transfers.byTransfer_id(transfer_id).cancel.post(body: CancelPostRequestBody, requestConfiguration?: RequestConfiguration<object>): Promise<undefined | Workspace_transfer_cancelled>Description
Aborts an in-flight transfer. Idempotent: cancelling an already-terminal transfer returns aborted: false with the current status. The request body is optional.
Parameters
Path Parameters
session_idstring requiredExample:
a1b2c3d4-e5f6-7890-abcd-ef1234567890The session UUID.
transfer_idstring requiredExample:
tr_exampleThe workspace transfer identifier.
Request Body
reasonstring optionalExample:
exampleOptional caller-visible audit/debug context.
Request Sample
Response Example
More Information
See /v2/agents/sessions/{session_id}/workspace/transfers/{transfer_id}/cancel in the API reference for additional detail on responses, headers, parameters, and more.