Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop/ Deletes one desktop.

Updated on 2024-01-10 GMT+08:00

View PDF

Deletes one desktop.

Deletes one desktop. The deleted desktop cannot be restored.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

DELETE /v2/{project_id}/desktops/{desktop_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
desktop_id	Yes	String	Desktop ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
delete_users	No	Boolean	After a desktop is deleted, if the current user does not have other desktops, the desktop user can be deleted. The options are true (yes) and false (no). The default value is false.
email_notification	No	Boolean	Whether to send an email notification to the desktop user after a desktop is deleted. The options are true (yes) and false (no). The default value is true.
is_force_delete	No	Boolean	Forcible deletion or not.

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	No	String	MIME type of the request body.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 409

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.

/v2/0bec5db98280d2d02fd6c00c2de791ce/desktops/a130ab3a-72bf-4b71-baa9-af4987c8e338

Status code: 204

Normal, no response body.

null

Status Code	Description
204	Normal, no response body.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	You do not have required permissions.
404	No resource found.
409	Operation conflict.
500	An internal service error occurred. For details about the error code, see the error code description.