Exporting Private Keys of Key Pairs in Batches

This API is used to export private keys of key pairs in batches. A maximum of 10 private keys can be selected at a time.

For details, see Calling APIs.

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Request header parameters
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 parameters
Parameter	Mandatory	Type	Description
[items]	Yes	Array of Keypairs objects	-

**Table 4** Keypairs
Parameter	Mandatory	Type	Description
keypair	Yes	Keypair object	Key pair information

**Table 5** Keypair
Parameter	Mandatory	Type	Description
name	No	String	SSH key pair name
type	No	String	Type of the SSH key pair. The value can be ssh or x509.
scope	No	String	Tenant-level or user-level. The value can be domain or user.
public_key	No	String	Public key information about an SSH key pair
fingerprint	No	String	Fingerprint information about an SSH key pair
is_key_protection	No	Boolean	Whether to host keys
frozen_state	No	String	Frozen Status - 0: normal, not frozen - 1: frozen due to common causes - 2: frozen by the public security bureau - 3: frozen due to common causes and by the public security bureau - 4: frozen due to violations - 5: frozen due to common causes and violations - 6: frozen by the public security bureau and due to violations - 7: frozen by the public security bureau and due to common causes and violations - 8: frozen due to lack of real-name authentication - 9: frozen due to common causes and lack of real-name authentication - 10: frozen by the public security bureau and due to lack of real-name authentication

Status code: 200

Request succeeded.

None

Export the demo2, demo3, and demo4 SSH key pairs in batches.

[ {
  "keypair" : {
    "name" : "demo2"
  }
}, {
  "keypair" : {
    "name" : "demo3"
  }
}, {
  "keypair" : {
    "name" : "demo4"
  }
} ]

Status code: 200

Request succeeded.

"keypairs.zip"

Status Code	Description
200	Request succeeded.

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel