Create a key pair
Updated at：2025-10-20
This API enables the creation of key pairs, with a default limit of 500 per user in a single region (including created and imported key pairs). Created key pairs can be inserted into BCC instances for remote login.
Request structure
Plain Text
1POST /v{version}/keypair HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
4{
5 "name": "keypair01",
6 "description": "some description"
7}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 |
| 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 |
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) | Created 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 |
Request example
Plain Text
1POST /v2/keypair 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}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 {
9 "keypairId": "k-y7VWq",
10 "name": "keypair01",
11 "description": "someDescription",
12 "createTime": "2018-01-27T13:23:13Z",
13 "regionId": "bj",
14 "publicKey": "publicKey-publicKey"
15 "privateKey":"privateKey-privateKye"
16 }
17}