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

Request

Base URL
https://ascii.dev/api/box/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ascii/apis/box-public-api-v1/docs/boxes/:boxId/sshkey/post.ts
A function with typed inputs. Its response is checked against the schema.

boxIdstring required

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

keystring required

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

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

SSH key setup result.

okboolean required

typestring required

Stable success envelope discriminator added by v1.

successboolean

machineIpstring nullable

sshUserstring

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

No recorded changes to this operation across all 1 revision of this API.