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_id string required

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

The session UUID.

transfer_id string required

Example: tr_example

The workspace transfer identifier.

Request Body

reason string optional

Example: example

Optional caller-visible audit/debug context.

Request Sample

Show Request Sample
import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

const response = await client.v2.agents.sessions
    .bySession_id("a1b2c3d4-e5f6-7890-abcd-ef1234567890").workspace.transfers
    .byTransfer_id("tr_example").cancel.post({
    reason: "example",
});

Response Example

Show Response Example
{
  "transfer_id": "example",
  "aborted": true,
  "status": "pending"
}

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.

We can't find any results for your search.

Try using different keywords or simplifying your search terms.