Import a key pair
Updated at：2025-10-20
This API is used for users to import and create key pairs. The encryption method supported for the imported key pair in the request parameters is: - rsa - dsa - ssh-rsa - ssh-dss - ecdsa
Request structure
Plain Text
1PUT /v{version}/keypair?{action} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "name": "keypair01",
7 "description": "some description",
8 "publicKey": "your-pulicKey"
9}Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| action | String | Yes | Query | Operation executed on the key pair, current value: import |
| name | String | Yes | RequestBody | The key pair name supports uppercase and lowercase letters, numbers, Chinese characters, and -_/special characters. It must start with a letter and be between 1 and 65 characters in length. |
| description | String | No | RequestBody | Description of the key pair to be created |
| publicKey | String | Yes | RequestBody | Public key content |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| keypair | [KeypairModel](BCC/API Reference/Appendix.md#KeypairModel) | Key pair object |
Error codes
| Error code | Error description | HTTP status code | Chinese explanation |
|---|---|---|---|
| Keypair.KeypairNameInvalid | Keypair name is invalid. | 400 | Incorrect key pair name |
| Keypair.KeypairDescriptionInvalid | Keypair description is invalid. | 400 | Incorrect key pair description |
| Keypair.KeypairQuotaExceedLimit | Keypair number exceeds the limit. | 413 | Key pair count exceeds the limit |
| Keypair.KeypairPublicKeyExist | Keypair already exist. | 400 | The public key already exists. |
| Keypair.PublicKeyFormatInvalid | Public key format is invalid. | 400 | The public key format is incorrect |
Request example
Plain Text
1POST /v2/keypair?import HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4{
5 "name": "keypair01",
6 "description": "some description",
7 "publicKey": "your-publicKey"
8}Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{
7 "keypair":{
8 "instanceCount":0,
9 "name":"keypair01",
10 "description":"from import",
11 "createdTime":"2019-01-30T11:52:41Z",
12 "publicKey":"publicKey",
13 "fingerPrint":"fingerPrint",
14 "regionId":"bj",
15 "keypairId":"keypairId"
16 }
17}