Help Center/ Data Encryption Workshop/ API Reference (Ally Region)/ APIs/ Key Pair Service/ Exporting a Private Key
Updated on 2025-12-29 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.

URI

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

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

KeypairBean object

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

Parameter

Mandatory

Type

Description

name

Yes

String

SSH key pair name

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 code

error_msg

String

Error description

Example Request

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

Example Response

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

For details, see Error Codes.

Parent topic: Key Pair Service