Skip to main content
POST
Add SSH key to instance

Authorizations

Authorization
string
header
required

Bearer token authentication. Provide your API token prefixed with "Bearer ", e.g. "Bearer your-api-token".

Path Parameters

id
string
required

Instance ID

Body

application/json

Optional: provide an existing public key to add

Optional: provide an existing public key to add

public_key
string

Optional SSH public key material. Omit to have a key pair generated and the private key returned.

Response

OK

success
boolean
required

Whether the key was successfully added

uuid
string
required
key
string

Private key (only when generated)

message
string

Status message