API reference · Schema
SshKey
objectstringrequiredAlways `ssh_key`: the type of this object
One of
ssh_keyidstringrequiredUnique ID (`ssh_…`)
ID with prefix ssh_
project_idstringrequiredProject it belongs to
ID with prefix prj_
namestringrequiredIts name
public_keystringrequiredKey type and base64 key data, without the comment
fingerprintstringrequiredSHA-256 fingerprint, in the form `ssh-keygen -l` prints
created_by_user_idstring | nullrequiredID of the user who created it
created_byobject | nullrequiredWho created it (null: created by the platform)
ShowHide 3 fields of
created_byobjectstringrequiredAlways `person`
One of
personidstringrequiredThe person’s user ID (`usr_…`)
namestring | nullrequiredTheir name as they set it; null when they are no longer a member of the organization
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
Example
{
"object": "ssh_key",
"id": "ssh_01jc5zq4m8k3v6x9t2w7r0b1e4",
"project_id": "prj_01jc5zq4m8k3v6x9t2w7r0b1e4",
"name": "string",
"public_key": "string",
"fingerprint": "SHA256:…",
"created_by_user_id": "string",
"created_by": {
"object": "person",
"id": "string",
"name": "string"
},
"created_at": "2026-01-01T00:00:00.000Z"
}Used by
- List SSH keys
GET /v1/ssh-keys - Add an SSH public key
POST /v1/ssh-keys - Get an SSH key
GET /v1/ssh-keys/{ssh_key_id} - Rename an SSH key
PATCH /v1/ssh-keys/{ssh_key_id}