Skip to main content
POST
/
cloud
/
v1
/
keypairs
/
{project_id}
/
{region_id}
Import or generate keypair
curl --request POST \
  --url https://api.gcore.com/cloud/v1/keypairs/{project_id}/{region_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sshkey_name": "<string>",
  "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDFHrnwGVBZs6q6vmTBzQFfzdRLQW8N6Rd0ogGe3h8tm83ZJLTTsF+1H4JcOvwI5ETkHMaFIWd2U15nHU5M7plE6UPRKfzy4rq6yI6cE4tojd3A9attMpbEEX7EbGKrbrb4AsjzxHKAVaREAb31ZplJkUlsiees25hTQXBcWQnOESlc9RCxZ/QQgNUUgqm7QGg7CNkL8Mpq9V4YaOhcFGWj0jXP1CL3g6Xe3xJo1CmUbkIOGUyAmrSfLEiy2O91iOUhbmYQyXksznNrT9O6uLkijf6syLZOdyAuUd/Z86eYXej4/YsvIA5eIFU4B6y9zOXEO2A81txPYMRAytYt7+e7 alice@alice",
  "shared_in_project": true
}
'
{
  "id": "<string>",
  "name": "<string>",
  "public_key": "<string>",
  "shared_in_project": true,
  "state": "ACTIVE",
  "created_at": "2023-11-07T05:31:56Z",
  "fingerprint": "86:75:ce:e7:e9:1e:f0:79:ec:6f:d8:92:9b:43:fc:4d",
  "private_key": "<private_key>",
  "project_id": 1
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
project_id
integer
required

Project ID

​
region_id
integer
required

Region ID

Body

application/json
​
sshkey_name
string
required

Keypair name

Required string length: 1 - 255
​
public_key
string | null

Public part of the key. To generate public and private keys in the platform, do not specify the parameter in the request body.

Example:

"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDFHrnwGVBZs6q6vmTBzQFfzdRLQW8N6Rd0ogGe3h8tm83ZJLTTsF+1H4JcOvwI5ETkHMaFIWd2U15nHU5M7plE6UPRKfzy4rq6yI6cE4tojd3A9attMpbEEX7EbGKrbrb4AsjzxHKAVaREAb31ZplJkUlsiees25hTQXBcWQnOESlc9RCxZ/QQgNUUgqm7QGg7CNkL8Mpq9V4YaOhcFGWj0jXP1CL3g6Xe3xJo1CmUbkIOGUyAmrSfLEiy2O91iOUhbmYQyXksznNrT9O6uLkijf6syLZOdyAuUd/Z86eYXej4/YsvIA5eIFU4B6y9zOXEO2A81txPYMRAytYt7+e7 alice@alice"

​
shared_in_project
boolean | null
default:true

Keypair is shared for all users in the project. Default True

Example:

true

Response

200 - application/json

OK

​
id
string
required

Key ID, equal to sshkey_name

​
name
string
required

Keypair name

Required string length: 1 - 255
​
public_key
string
required

Public part of the key. To generate public and private keys in the platform, do not specify the parameter in the request body.

​
shared_in_project
boolean
required

Keypair is shared for all users in the project

​
state
enum<string>
required

Keypair state

Available options:
ACTIVE,
DELETING
​
created_at
string<date-time> | null

Keypair creation datetime

​
fingerprint
string | null

Key fingerprint

Example:

"86:75:ce:e7:e9:1e:f0:79:ec:6f:d8:92:9b:43:fc:4d"

​
private_key
string | null

Private part of the key

Example:

"<private_key>"

​
project_id
integer | null

Project ID

Example:

1