Help Center/ Organizations/ API Reference/ APIs/ Managing Tags/ Deleting Tags with the Specified Key from the Specified Resource Type

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

View PDF

Deleting Tags with the Specified Key from the Specified Resource Type

Function

This API is used to delete any tags with the specified key from the specified resource type. You can attach tags to accounts, OUs, roots, and policies of an organization. This API can be called only from the organization's management account.

Debugging

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

URI

POST https://{endpoint}/v1/organizations/{resource_type}/{resource_id}/tags/delete

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
resource_type	Yes	String	Resource type. It can be organizations:policies, organizations:ous, organizations:accounts, or organizations:roots.
resource_id	Yes	String	Unique ID of the root, OU, account, or policy.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
tags	Yes	Array of TagDto objects	List of tags you want to add to the specified resource.

**Table 4** TagDto
Parameter	Mandatory	Type	Description
key	Yes	String	Identifier or name of the tag key.
value	Yes	String	String value associated with the tag key. You can set the tag value to an empty string, but cannot set it to NULL.

Response Parameters

None

Example Requests

Deleting tags with the specified key from the specified resource type

POST https://{endpoint}/v1/organizations/{resource_type}/{resource_id}/tags/delete

{
  "tags" : [ {
    "key" : "keystring",
    "value" : "valuestring"
  } ]
}