v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB

SSH Keys

Add or generate SSH key

To generate a key, omit the public_key parameter from the request body

post/cloud/v1/ssh_keys/{project_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

Request body

namestring required

SSH key name

public_keystring

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_projectboolean

SSH key is shared with all users in the project

Example request

{
  "name": "my-ssh-key",
  "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIjxL6g1II8NsO8odvBwGKvq2Dx/h/xrvsV9b9LVIYKm my-username@my-hostname",
  "shared_in_project": true
}

Response

Created

created_atstring date-time required

SSH key creation time

fingerprintstring required

Fingerprint

idstring uuid4 required

SSH key ID

namestring required

SSH key name

private_keystring nullable 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.

project_idinteger required

Project ID

public_keystring 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_projectboolean required

SSH key will be visible to all users in the project

state'ACTIVE' | 'DELETING' required

Example response

{
  "created_at": "2025-06-16T17:05:50Z",
  "fingerprint": "86:75:ce:e7:e9:1e:f0:79:ec:6f:d8:92:9b:43:fc:4d",
  "id": "36a7a97a-0672-4911-8f2b-92cd4e5b0d91",
  "name": "my-ssh-key",
  "private_key": "<private_key>",
  "project_id": 1,
  "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIjxL6g1II8NsO8odvBwGKvq2Dx/h/xrvsV9b9LVIYKm my-username@my-hostname",
  "shared_in_project": true
}