Help Center/ Organizations/ API Reference/ APIs/ Managing Tags/ Adding Tags to the Specified Resource
Updated on 2024-10-21 GMT+08:00
View PDF
Share

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 the following resources in Organizations: accounts, OUs, roots, and policies. 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/resources/{resource_id}/tag

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

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

Adding Tags to the Specified Resource

POST https://{endpoint}/v1/organizations/resources/{resource_id}/tag

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

Example Responses

None

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.

Parent topic: Managing Tags