Help Center/ Workspace/ API Reference/ Workspace APIs/ Desktop Tag/ Deleting a Desktop Tag

Updated on 2025-07-14 GMT+08:00

View PDF

Deleting a Desktop Tag

Deletes a desktop tag. If the tag to be deleted does not exist, the deletion is considered successful.

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}/tags/{key}

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

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).
Content-Type	No	String	MIME type of the request body.

Status code: 204

Response to the request for deleting a desktop tag.

Status code: 400

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error description.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

None

None

Status Code	Description
204	Response to the request for deleting a desktop tag.
400	Invalid parameter.
401	Authentication failed.
403	You do not have required permissions.
404	Resource not found.
500	Internal error.