Importing SSH Key Pairs in Batches

Function

This API is used to batch import SSH key pairs. A maximum of 10 SSH key pairs can be selected at a time.

Calling Method

For details, see Calling APIs.

URI

POST /v3/{project_id}/keypairs/batch-import

**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 CreateKeypairRequestBody objects	Request body for creating a key pair

**Table 4** CreateKeypairRequestBody
Parameter	Mandatory	Type	Description
keypair	Yes	CreateKeypairAction object	Parameter in the request body for creating a key pair

**Table 5** CreateKeypairAction
Parameter	Mandatory	Type	Description
name	Yes	String	SSH key pair name. The key pair name must be unique. The SSH key pair name can contain at most 255 characters, including letters, digits, underscores (_), and hyphens (-).
type	No	String	SSH key pair type. The value can be ssh or x509.
public_key	No	String	String of an imported public key
scope	No	String	Tenant-level or user-level. The value can be domain or user.
user_id	No	String	User that an SSH key pair belongs to
key_protection	No	KeyProtection object	Private key hosting and protection for the SSH key pair.

**Table 6** KeyProtection
Parameter	Mandatory	Type	Description
private_key	No	String	Private key of the imported SSH key pair.
encryption	Yes	Encryption object	How a private key is encrypted and stored.

**Table 7** Encryption
Parameter	Mandatory	Type	Description
type	Yes	String	Value options: - default: The default encryption mode. Applicable to sites where KMS is not deployed. - kms: KMS encryption mode. If the KMS service is not available at the site, set this parameter to default.
kms_key_name	No	String	KMS key name. If type is set to kms, you must enter the KMS key name or ID.
kms_key_id	No	String	KMS key ID. If type is set to kms, you must enter the KMS key name or ID.

Response Parameters

Status code: 200

**Table 8** Response body parameters
Parameter	Type	Description
failed_keypairs	Array of FailedKeypair objects	Information about the SSH key pair that fails to be imported and the failure cause
succeeded_keypairs	Array of CreateKeypairResponseBody objects	Information about the imported SSH key pair

**Table 9** FailedKeypair
Parameter	Type	Description
keypair_name	String	SSH key pair name
failed_reason	String	Import failure cause

**Table 10** CreateKeypairResponseBody
Parameter	Type	Description
keypair	CreateKeypairResp object	SSH key pair details

**Table 11** CreateKeypairResp
Parameter	Type	Description
name	String	SSH key pair name
type	String	SSH key pair type. The value can be ssh or x509.
public_key	String	Public key information about an SSH key pair
private_key	String	Private key information about an SSH key pair. - When an SSH key pair is created, the response contains private_key information. - When an SSH key pair is imported, the response does not contain private_key information.
fingerprint	String	Fingerprint information about an SSH key pair
user_id	String	User that an SSH key pair belongs to

Example Requests

Import the demo2 and demo3 SSH key pairs in batches.

[ {
  "keypair" : {
    "name" : "demo2",
    "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova"
  }
}, {
  "keypair" : {
    "name" : "demo3",
    "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova"
  }
} ]

Example Responses

Status code: 200

The SSH key pairs are imported in batches.

{
  "failed_keypairs" : [ {
    "keypair_name" : "demo3",
    "failed_reason" : "{\"error_code\":\"KPS.7004\", \"error_msg\":\"Key pair 'demo3' already exists.\"}"
  } ],
  "succeeded_keypairs" : [ {
    "keypair" : {
      "name" : "demo2",
      "fingerprint" : "SHA256:Wm91+h496cPk5JleSp4RdD2n4Z/5KdlDeD51lmiZ11M",
      "type" : "ssh",
      "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAA... Generated-by-Nova",
      "user_id" : "6c2a33b1b8474d0dbac0a24297127525"
    }
  } ]
}

Status Codes

Status Code	Description
200	The SSH key pairs are imported in batches.

Error Codes

See Error Codes.

Parent Topic: Key Pair Management

Previous topic: Exporting a private key

Next topic: Exporting Private Keys of Key Pairs in Batches

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

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

The system is busy. Please try again later.