Exporting a private key
Function
This API is used to 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
| 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 |
Request 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 |
| 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 |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| keypair | ExportPrivateKeyKeypairBean object | Definition Information about the exported private key Range N/A |
Example Requests
{
"keypair" : {
"name" : "demo2"
}
} Example Responses
Status code: 200
Request succeeded.
{
"keypair" : {
"name" : "demo2",
"private_key" : "-----BEGIN RSA PRIVATE KEY-----..."
}
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Request succeeded. |
Error Codes
See Error Codes.