Skip to main content
POST
Configure box SSH key

Authorizations

Authorization
string
header
required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Path Parameters

boxId
string
required

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

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Body

application/json
key
string
required

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

Example:

"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAA... user@host"

Response

SSH key setup result.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

success
boolean
machineIp
string | null
sshUser
string
Example:

"user"