Who am I HTTP GET /me

List the runtimes new sandboxes may use (how a sandbox runs: dind, sysbox; ALLOWED_RUNTIMES) HTTP GET /runtimes

List all sandboxes HTTP GET /sandboxes

Create sandbox HTTP POST /sandboxes

Archive sandbox

Stops the sandbox, saves its volumes (tar.gz) and config under opt/archive//, then removes containers, volumes and the sandbox directory. Nothing is removed if archiving fails. HTTP DELETE /sandboxes/{name}

Get sandbox details HTTP GET /sandboxes/{name}

Change sleep settings

Changes idle_timeout and/or deep_sleep_after of an existing sandbox. A new idle_timeout recreates only the socat container (a running sandbox's app is unreachable for a few seconds; an asleep one stays asleep) and applies to the next request's Sablier session. A new deep_sleep_after applies immediately. HTTP PATCH /sandboxes/{name}

The starter stack Purgatorium deployed into the sandbox (compose YAML), secrets masked HTTP GET /sandboxes/{name}/compose

Put a sandbox into deep sleep now (containers and network down, data kept; the next request or start rebuilds it) HTTP POST /sandboxes/{name}/deep-sleep

New Docker access certificates (enable / rotate)

New CA, server and client certificates for the sandbox's Docker API (they carry -docker.); earlier exports stop working. Restarts the sandbox. HTTP POST /sandboxes/{name}/docker-keys

Delete a file or a folder (with everything in it) of the sandbox's files HTTP DELETE /sandboxes/{name}/files

List a folder of the sandbox's files (/root, /home, /srv and /opt, the folders kept over a deep sleep, and the apps' volumes: see list_sandbox_volumes) HTTP GET /sandboxes/{name}/files

Upload a file into the sandbox's files (replaces one of the same name); its folder must exist HTTP PUT /sandboxes/{name}/files/content

Create a folder (and its parents) in the sandbox's files HTTP POST /sandboxes/{name}/files/mkdir

Read a text file of the sandbox's files (UTF-8, up to 1 MB) HTTP GET /sandboxes/{name}/files/text

Start the sleep countdown over

For a running sandbox: one request through its router, as any visit would, so it sleeps a full idle timeout from now. Does not wake a sleeping sandbox. HTTP POST /sandboxes/{name}/keep-awake

Unmount a host folder from the sandbox (admin)

Admin only: removes the host mount on this target (also when HOST_MOUNT_ROOTS is no longer set). The sandbox container is recreated as for adding one. HTTP DELETE /sandboxes/{name}/mounts

Host folders mounted into the sandbox

The host folders the administrator mounted into the sandbox (host path, target inside the sandbox, readonly). enabled: whether HOST_MOUNT_ROOTS is set on this server; the admin also gets roots, the folders that may be mounted. HTTP GET /sandboxes/{name}/mounts

Mount a host folder into the sandbox (admin)

Admin only, with HOST_MOUNT_ROOTS set: bind-mounts a host folder at or under one of those roots into the sandbox container (its own Docker's apps can bind it from there too). The sandbox's owner gets that folder as root. The sandbox container is recreated: a running sandbox restarts (its apps are unreachable for a few seconds), an asleep one stays asleep, one in deep sleep gets it when it wakes. A host folder that does not exist is an error from Docker, not an empty new folder. HTTP POST /sandboxes/{name}/mounts

A single-use link to the project's .p9m folder, with the sandbox's Docker keys

Answers a link that works once, for 5 minutes, and the command that unpacks it into the project (curl -sf "<url>" | tar -x -C "<project folder>"): the .p9m folder with .gitignore, p9m.env and docker/{ca,cert,key}.pem, the keys checked first. Run the command yourself; never copy a key. Then the docker context commands (a context keeps its own copies of the files: remove it and create it again after new keys or any TLS error, with a new link). An expired or used link answers 410: ask for a new one. HTTP POST /sandboxes/{name}/project-link

The sandbox's images in the p9m registry, with secret-scan results HTTP GET /sandboxes/{name}/registry

Delete a version of one of the sandbox's images from the p9m registry

The app name is URL-encoded when it has slashes (team%2Fapi for /team/api). An index takes its platform manifests with it; the space comes back at the weekly garbage collection. HTTP DELETE /sandboxes/{name}/registry/{app}/{digest}

Restart sandbox HTTP POST /sandboxes/{name}/restart

The sandbox's generated SSH private key (for ssh -i) HTTP GET /sandboxes/{name}/ssh-key

Generate the SSH key of a sandbox that has none yet (created with SSH) HTTP POST /sandboxes/{name}/ssh-key

Start sandbox

Wakes an asleep or deep-sleeping sandbox. At the owner's limit (running sandboxes, slots, or a full server) it answers 409 with reason and the running sandboxes; {"sleep": "<name>"} puts one of them to sleep first. HTTP POST /sandboxes/{name}/start

Stop sandbox HTTP POST /sandboxes/{name}/stop

The volumes of the apps in the sandbox's own Docker; their files are under each one's path, through the files tools HTTP GET /sandboxes/{name}/volumes

How many sandboxes: allowed, running, asleep, in deep sleep, archived

A user: their own, against their quota (SANDBOX_QUOTA; free = how many more they may create). The admin: the whole server, and by_owner per owner. Asleep = stopped (also one that failed to start); archived = deleted sandboxes kept in the archive, not counted against the quota. HTTP GET /sandboxes/summary

Your SSH public keys (they let you into your sandboxes as root) HTTP GET /ssh-keys

Add an SSH public key: it lets you into all your sandboxes with SSH as root HTTP POST /ssh-keys

Delete one of your SSH keys (it no longer lets you in, at once) HTTP DELETE /ssh-keys/{id}

List the templates (what runs inside a sandbox) HTTP GET /templates

A template's compose.yaml as written (to show or edit before a create) HTTP GET /templates/{name}

List personal access tokens (admin: all) HTTP GET /tokens

Create a personal access token (shown once) HTTP POST /tokens

Revoke a personal access token HTTP DELETE /tokens/{id}