Help Center/ Data Encryption Workshop/ API Reference/ APIs/ Key Pair Management APIs/ Key Pair Management/ Exporting Private Keys of Key Pairs in Batches
Updated on 2025-10-16 GMT+08:00
View PDF
Share

Exporting Private Keys of Key Pairs in Batches

Function

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.

Calling Method

For details, see Calling APIs.

Authorization Information

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, no identity policy-based permission required for calling this API.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

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

List of keys to be exported.
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

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

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

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

Example Responses

Status code: 200

Request succeeded.

"keypairs.zip"

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Key Pair Management