Exporting a private key

This API is used to export the private key of a specified key pair.

For details, see Calling APIs.

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

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

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

**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
keypair	Yes	KeypairBean object	Definition Information about the key pair whose private key is to be exported Constraints N/A Range N/A Default Value N/A

**Table 4** KeypairBean
Parameter	Mandatory	Type	Description
name	Yes	String	Definition SSH key pair name Constraints N/A Range N/A Default Value N/A

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
keypair	ExportPrivateKeyKeypairBean object	Definition Information about the exported private key Range N/A

**Table 6** ExportPrivateKeyKeypairBean
Parameter	Type	Description
name	String	Definition SSH key pair name Range N/A
private_key	String	Definition Private key of the SSH key pair Range N/A

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

Status code: 200

Request succeeded.

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

Status Code	Description
200	Request succeeded.

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.