v2

latestOpenAPI 3.1.02026-08-07139158192.4 KB
SSH Keys

Add an SSH public key (computes fingerprint)

post/v1/orgs/{orgId}/ssh-keys/create

Path parameters

orgIdstring required

Request body

namestring required
publicKeystring required

Response

Added

attachedVmCountinteger

Number of live (non-terminated) VMs this key is attached to. Zero means the key is not scoped to any VM. The dashboard shows an "in use" indicator and warns before deleting a key that is in use.

blockingVmsstring[]

Names of VMs for which this is the only key that still resolves to a live org key. Deleting the key is refused (409) while this is non-empty; attach another key to those VMs first.

createdAtstring required
fingerprintstring required
idstring required
namestring required
publicKeystring required