v32

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

SSH Keys

Share or unshare SSH key with users

patch/cloud/v1/ssh_keys/{project_id}/{ssh_key_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

ssh_key_idstring uuid4 required

SSH key ID

Example:36a7a97a-0672-4911-8f2b-92cd4e5b0d91

SSH key ID

Request body

shared_in_projectboolean required

Share your ssh key with all users in the project

Example request

{
  "shared_in_project": true
}

Response

created_atstring date-time nullable required

SSH key creation time

fingerprintstring required

Fingerprint

idstring uuid4 required

SSH key ID

namestring required

SSH key name

project_idinteger nullable 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",
  "project_id": 1,
  "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIjxL6g1II8NsO8odvBwGKvq2Dx/h/xrvsV9b9LVIYKm my-username@my-hostname",
  "shared_in_project": true
}