Help Center> Organizations> API Reference> API> Managing Tags> Removing Tags from the Specified Resource
Updated on 2024-03-15 GMT+08:00
View PDF

Removing Tags from the Specified Resource

Function

This API is used to remove any tags with the specified key from the specified resource. You can attach tags to the following resources in Organizations: accounts, OUs, roots, and policies. This API can be called only from the organization's management account.

URI

POST /v1/organizations/resources/{resource_id}/untag

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

resource_id

Yes

String

Unique ID of the root, OU, account, or policy.

Maximum: 130

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.

Minimum: 1
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

tag_keys

Yes

Array of strings

Minimum: 1

Maximum: 128

Array Length: 1 - 20

Response Parameters

None

Example Requests

Removing any tags with the specified key from the specified resource

POST https://{hostname}/v1/organizations/resources/{resource_id}/untag

{
  "tag_keys" : [ "key1" ]
}

Example Responses

None

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.

Parent topic: Managing Tags