Help Center/ Data Encryption Workshop/ API Reference (Ally Region)/ APIs/ Key Pair Service/ Importing a Private Key
Updated on 2025-12-29 GMT+08:00
View PDF
Share

Importing a Private Key

Function

Import a private key to a specified key pair.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/keypairs/private-key/import

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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.
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

keypair

Yes

ImportPrivateKeyKeypairBean object

Information about the key pair to be imported
Table 4 ImportPrivateKeyKeypairBean

Parameter

Mandatory

Type

Description

name

Yes

String

SSH key pair name. A new key pair cannot use the same name as an existing one. The name can contain at most 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

user_id

No

String

User to whom an SSH key pair belongs

key_protection

Yes

ImportPrivateKeyProtection object

SSH key pair private key management and protection.
Table 5 ImportPrivateKeyProtection

Parameter

Mandatory

Type

Description

private_key

Yes

String

Private key of the imported SSH key pair.

encryption

Yes

Encryption object

Encryption method for the private key.
Table 6 Encryption

Parameter

Mandatory

Type

Description

type

Yes

String

The value can be kms or default.

  • default: default encryption mode, which applies to sites where the KMS service is not deployed.

  • kms: KMS encryption mode.

    If KMS is unavailable, set this parameter to default.

kms_key_name

No

String

KMS key name.

  • If type is set to kms, you must enter the KMS key name or ID.

kms_key_id

No

String

KMS key ID.

  • If type is set to kms, you must enter the KMS key name or ID.

Response Parameters

Status code: 200

Table 7 Response body parameter

Parameter

Type

Description

keypair

ImportPrivateKeyKeypairBean object

N/A
Table 8 ImportPrivateKeyKeypairBean

Parameter

Type

Description

name

String

SSH key pair name. A new key pair cannot use the same name as an existing one. The name can contain at most 64 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

user_id

String

User to whom an SSH key pair belongs

key_protection

ImportPrivateKeyProtection object

SSH key pair private key management and protection.
Table 9 ImportPrivateKeyProtection

Parameter

Type

Description

private_key

String

Private key of the imported SSH key pair.

encryption

Encryption object

Encryption method for the private key.
Table 10 Encryption

Parameter

Type

Description

type

String

The value can be kms or default.

  • default: default encryption mode, which applies to sites where the KMS service is not deployed.

  • kms: KMS encryption mode.

    If KMS is unavailable, set this parameter to default.

kms_key_name

String

KMS key name.

  • If type is set to kms, you must enter the KMS key name or ID.

kms_key_id

String

KMS key ID.

  • If type is set to kms, you must enter the KMS key name or ID.

Status code: 400

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Request

{
  "keypair" : {
    "name" : "demo2",
    "key_protection" : {
      "private_key" : "-----BEGIN RSA PRIVATE KEY-----...",
      "encryption" : {
        "type" : "kms",
        "kms_key_name" : "kps/default"
      }
    }
  }
}

Example Response

Status code: 200

Request succeeded.

{
  "keypair" : {
    "name" : "demo2"
  }
}

Status code: 400

Error response

{
  "error_code" : "KPS.XXX",
  "error_msg" : "XXX"
}

Status Codes

Status Code

Description

200

Request succeeded.

400

Error response

Error Codes

For details, see Error Codes.

Parent topic: Key Pair Service