Skip to navigation
API Referencessh-keys

Create or register an SSH key pair

If publicKey is provided, registers your existing public key. If omitted, generates a new key pair and returns the private key (shown only once).

Authentication

X-API-Client-IDstring
API Client ID
X-API-Client-Secretstring
API Client Secret

Request

This endpoint expects an object.
namestringRequired
Name of the SSH key pair
publicKeystringOptional
Public key to register. If provided, the key pair is registered using your existing key. If omitted, a new key pair is generated and the private key is returned.

Response

The SSH key pair has been created or registered
namestring
Name of the SSH key pair
fingerprintstring
Fingerprint of the public key
privateKeystringOptional

Private key of the created SSH key pair. Only returned when a new key pair is generated (no public key provided).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error