Authorizations
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
1
Body
SSH key name
1 - 255
"my-ssh-key"
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.
"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIjxL6g1II8NsO8odvBwGKvq2Dx/h/xrvsV9b9LVIYKm my-username@my-hostname"
SSH key is shared with all users in the project
true
false
Response
Created
SSH key creation time
"2025-06-16T17:05:50Z"
Fingerprint
"86:75:ce:e7:e9:1e:f0:79:ec:6f:d8:92:9b:43:fc:4d"
SSH key ID
"36a7a97a-0672-4911-8f2b-92cd4e5b0d91"
SSH key name
1 - 255
"my-ssh-key"
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.
"<private_key>"
Project ID
1
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.
"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIjxL6g1II8NsO8odvBwGKvq2Dx/h/xrvsV9b9LVIYKm my-username@my-hostname"
SSH key will be visible to all users in the project
true
SSH key state
ACTIVE
, DELETING