Help Center> Organizations> API Reference> API> Managing Tags> Adding Tags to the Specified Resource

Updated on 2024-03-15 GMT+08:00

View PDF

Adding Tags to the Specified Resource

Function

This API is used to add one or more tags to the specified resource. You can attach tags to any of the following organization resources: accounts, OUs, roots, and policies. This API can be called only from the organization's management account.

URI

POST /v1/organizations/{resource_type}/{resource_id}/tags/create

**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. Enumeration values: organizations:policies organizations:ous organizations:accounts organizations:roots
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
tags	Yes	Array of TagDto objects	List of tags you want to add to the specified resource. Array Length: 1 - 20

**Table 4** TagDto
Parameter	Mandatory	Type	Description
key	Yes	String	Identifier or name of the tag key. Minimum: 1 Maximum: 128
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. Minimum: 0 Maximum: 255

Response Parameters

None

Example Requests

Adding Tags to the Specified Resource

POST https://{hostname}/v1/organizations/{resource_type}/{resource_id}/tags/create

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