Skip to main content
POST
/
cloud
/
v1
/
ssh_keys
/
{project_id}
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
ssh_key_created = client.cloud.ssh_keys.create(
    project_id=1,
    name="my-ssh-key",
)
print(ssh_key_created.id)
{
  "created_at": "2023-11-07T05:31:56Z",
  "fingerprint": "<string>",
  "id": "<string>",
  "name": "<string>",
  "private_key": "<private_key>",
  "project_id": 123,
  "public_key": "<string>",
  "shared_in_project": true,
  "state": "ACTIVE"
}

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

Body

application/json
​
name
string
required

SSH key name

Required string length: 1 - 255
​
public_key
string

The public part of an SSH key is the shareable portion of an SSH key pair. It can be safely sent to servers or services to grant access. It does not contain sensitive information.

  • If you’re uploading your own key, provide the public part here (usually found in a file like id_ed25519.pub).
  • If you want the platform to generate an Ed25519 key pair for you, leave this field empty — the system will return the private key in the response once only.
​
shared_in_project
boolean
default:true

SSH key is shared with all users in the project

Response

201 - application/json

Created

​
created_at
string<date-time>
required

SSH key creation time

​
fingerprint
string
required

Fingerprint

​
id
string<uuid4>
required

SSH key ID

​
name
string
required

SSH key name

Required string length: 1 - 255
​
private_key
string | null
required

The private part of an SSH key is the confidential portion of the key pair. It should never be shared or exposed. This key is used to prove your identity when connecting to a server.

If you omit the public_key, the platform will generate a key for you. The private_key will be returned once in the API response. Be sure to save it securely, as it cannot be retrieved again later.

Best practice: Save the private key to a secure location on your machine (e.g., ~/.ssh/id_ed25519) and set the file permissions to be readable only by you.

Example:

"<private_key>"

​
project_id
integer
required

Project ID

​
public_key
string
required

The public part of an SSH key is the shareable portion of an SSH key pair. It can be safely sent to servers or services to grant access. It does not contain sensitive information.

​
shared_in_project
boolean
required

SSH key will be visible to all users in the project

​
state
enum<string>
required

SSH key state

Available options:
ACTIVE,
DELETING