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

Importing Key Materials

Function

This API is used to import key materials.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/kms/import-key-material

**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

Request Parameters

**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
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
import_token	Yes	String	Definition Key import token in Base64 format Constraints The value must match the regular expression ^[0-9a-zA-Z+/=]{200,6144}$. Range N/A Default Value N/A
encrypted_key_material	Yes	String	Definition Encrypted symmetric key material in Base64 format Constraints The value must match the regular expression ^[0-9a-zA-Z+/=]{344,360}$. If an asymmetric key is imported, this parameter is used as the temporary intermediate key for private key encryption. Range N/A Default Value N/A
encrypted_privatekey	No	String	Definition Private key encrypted using a temporary intermediate key. Specify this parameter if an asymmetric key is imported. The value is in Base64 format. Constraints The value must match the regular expression ^[0-9a-zA-Z+/=]{200,6144}$. Range N/A Default Value N/A
expiration_time	No	Long	Definition Timestamp when the key material expires, that is, the total number of seconds since January 1, 1970. KMS will delete the key material within 24 hours after it expires. Constraints N/A Range N/A Default Value N/A
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

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Import ciphertext key materials to the key whose ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f.

{
  "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
  "import_token" : "AACIBjY2ZTQxYItNDU4Ny04OTIxLWVhZTVhZjg5NDZmXXXX",
  "encrypted_key_material" : "e0wTU/YJT/HDxsEv2NE+3CKT1XXXX"
}

Example Responses

None

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Key Import Management