Sign in

v1

latestOpenAPI 3.1.02026-07-22304756.7 KB
Box

Configure box SSH key

Adds an OpenSSH public key to the running Box so the caller can SSH as user user.

post/boxes/{boxId}/sshkey

Path parameters

boxIdstring required

Public Box id returned by create/list/get box calls.

Request body

keystring required

Public SSH key in OpenSSH format. Private keys are rejected.

Example request

{
  "key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAA... user@host"
}

Response

SSH key setup result.

okboolean required
typestring required

Stable success envelope discriminator added by v1.

successboolean
machineIpstring nullable
sshUserstring

Example response

{
  "ok": true,
  "sshUser": "user"
}