Desktop ›

Delete desktop link

DELETE/v1/sandboxes/{id}/desktop/links/{linkId}

Takes a link to the sandbox's desktop away before it expires. Its address leads nowhere from then on, and a stream that is open through it is cut, whether or not it was made with cutOnExpiry. It is done whatever state the sandbox is in. Turning the desktop off takes every link away.

RequestTypeScript

import { Agental } from "agental-sdk";
const agental = new Agental();
const sandbox = await agental.sandboxes.get("sbx_2a9a47e50daec64a");
await sandbox.desktop.deleteLink("dln_4f1c2a9b0d3e7c55");

Answer204 No Content

No body: the status says it was done.

The link leads nowhere.

Path

`id`required string	e.g. `"sbx_0123456789abcdef"`
`linkId`required string	The link's id. e.g. `"dln_4f1c2a9b0d3e7c55"`

Headers

Authorizationrequired

Bearer key

An API key that may make this call.

Returns

204 The link leads nowhere.

Errors and other answers

404	`not_found` there is no such sandbox, it has no such link, or the link has expired.

Every error answers { "error": { "code", "message" } }; a key without the action a call needs answers 403 key_action_forbidden, naming it.

← Create desktop link Click desktop →