Help Center/ Data Encryption Workshop/ API Reference/ APIs/ Key Pair Management APIs/ Key Pair Management/ Exporting a private key
Updated on 2025-10-16 GMT+08:00
View PDF
Share

Exporting a private key

Function

Export the private key of a specified key pair.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    kps:SSHKeyPair:exportPrivateKey

    Write

    SSHKeyPair *

    -
    • kps:domainKeypairs:exportpk

    kms:cmk:decryptDataKey

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

keypair

Yes

KeypairBean object

Information about the key pair whose private key is to be exported
Table 4 KeypairBean

Parameter

Mandatory

Type

Description

name

Yes

String

Name of the key pair.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

keypair

ExportPrivateKeyKeypairBean object

Information about the exported private key
Table 6 ExportPrivateKeyKeypairBean

Parameter

Type

Description

name

String

SSH key pair name.

private_key

String

Private key of the SSH key pair

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

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

Example Responses

Status code: 200

Request succeeded.

{
  "keypair" : {
    "name" : "demo2",
    "private_key" : "-----BEGIN RSA PRIVATE KEY-----..."
  }
}

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

See Error Codes.

Parent Topic: Key Pair Management