Updated on 2026-09-21 GMT+08:00

Adding Tags to a Key

This API is used to add a key tag.

For details, see Calling APIs.

POST /v1.0/{project_id}/kms/{key_id}/tags

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value returned by the IAM API is used, which contains 32 characters. Default Value N/A
key_id	Yes	String	Definition Key ID Constraints The value must be a 36-byte ID. The value must match the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Range N/A Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
tag	No	TagItem object	Tag.
sequence	No	String	Definition A 36-byte serial number of a request message, for example, 919c82d4-8046-4722-9094-35c3c6524cff. Constraints N/A Range N/A Default Value N/A

**Table 4** TagItem
Parameter	Mandatory	Type	Description
key	Yes	String	Definition Tag key Constraints The value can contain up to 36 Unicode characters. The value cannot contain ASCII characters (0–31), asterisks (), angle brackets (< and >), backslashes (), or equal signs (=). The value cannot be empty. Range* N/A Default Value N/A
value	No	String	Definition Tag value Constraints The value can contain up to 43 Unicode characters. The value cannot contain ASCII characters (0–31), asterisks (), angle brackets (< and >), backslashes (), or equal signs (=). The value cannot be empty. Range* N/A Default Value N/A

Status code: 204

No Content

None

Add a tag whose key is DEV and value is DEV1.

{
  "tag" : {
    "key" : "DEV",
    "value" : "DEV1"
  }
}

None

Status Code	Description
204	No Content