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
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID |
Request 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). |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
keypair |
Yes |
KeypairBean object |
Information about the key pair whose private key is to be exported |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
keypair |
ExportPrivateKeyKeypairBean object |
Information about the exported private key |
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
String |
SSH key pair name. |
|
private_key |
String |
Private key of the SSH key pair |
Status code: 400
|
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
