Create and import an SSH key pair

Function

This API is used to create and import an SSH key pair.

URI

POST /v3/{project_id}/keypairs

**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. The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
keypair	Yes	CreateKeypairAction object	Parameter in the request body for creating a key pair.

**Table 4** CreateKeypairAction
Parameter	Mandatory	Type	Description
name	Yes	String	SSH key pair name. The name of a key pair must be unique. The SSH key pair name can contain a maximum of 64 characters, including letters, digits, underscores (_), and hyphens (-).
type	No	String	SSH key pair type.
public_key	No	String	String of the imported public key.
scope	No	String	Tenant-level or user-level.
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 5** KeyProtection
Parameter	Mandatory	Type	Description
private_key	No	String	Private key of the imported SSH key pair.
encryption	No	Encryption object	How a private key is encrypted and stored.

**Table 6** Encryption
Parameter	Mandatory	Type	Description
type	No	String	Value options: default: The default encryption mode. Applicable to sites where KMS is not deployed. kms: KMS encryption mode. If KMS is not available, set this parameter to default.
kms_key_name	No	String	Name of a KMS key. If type is set to kms, this parameter is mandatory.

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
keypair	CreateKeypairResp object	SSH key pair details.

**Table 8** CreateKeypairResp
Parameter	Type	Description
name	String	SSH key pair name.
type	String	SSH key pair type.
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.

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

{
  "keypair" : {
    "name" : "demo2"
  }
}

Example Responses

Status code: 200

OK.

{
  "keypair" : {
    "name" : "demo",
    "type" : "ssh",
    "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB...",
    "private_key" : "-----BEGIN RSA PRIVATE KEY-----...",
    "fingerprint" : "49:ef:73:2b:9b:7f:2e:0c:58:d3:e3:42:8e:28:04:3b",
    "user_id" : "e4f380899b1248918f3d37098dc63746"
  }
}

Status code: 400

Error occurred.

{
  "error_code" : "KPS.XXX",
  "error_msg" : "XXX"
}

Status Codes

Status Code	Description
200	OK.
400	Error occurred.

Error Codes

See Error Codes.

Parent topic: Key Pair Management

Previous topic: Query the SSH key pair list

Next topic: Query SSH key pair details

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.See the reply and handling status in My Cloud VOC.

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

For any further questions, feel free to contact us through the chatbot.

Chatbot