Migrate Key

Available in Classic and VPC

Convert a global key to an isolation key. This conversion changes it to a Region isolation key usable only within the isolated Region, and the global key is deleted.

Note

If an isolation key with the same name already exists, the conversion can't be made. For more information about isolation keys, see Key Management Service key isolation.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
POST	/keys/{keyTag}/migrate

Request headers

For information about the headers common to all Key Management Service APIs, see the account authentication method in Key Management Service request headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`keyTag`	String	Required	Key tag Unique identifier for the key derived from the key name. See Get key list. Use to request encryption or decryption with REST APIs. Key tags are not treated as confidential information.

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`targetRegion`	String	Required	Conversion target Region `KR` \| `JPN` `KR`: Korea Region `JPN`: Japan Region

Note

Only Korea and Japan Regions are supported.

Request example

The request example is as follows:

curl --location --request POST 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c*****4y5z6/migrate' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "targetRegion": "KR"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`code`	String	-	Success or Failure
`data`	Object	-	Response result
`data.keyTag`	String	-	Key tag
`data.targetRegion`	String	-	Conversion target Region

Response status codes

For information about the HTTP status codes common to all Key Management Service APIs, see Key Management Service response status codes.

Response example

The response example is as follows:

{
    "code": "SUCCESS",
    "data": {
        "keyTag": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
        "targetRegion": "KR"
    }
}