Remotehost Docs
API ReferenceFiles

Read a directory tree

GET
/sandboxes/{sandboxId}/files/snapshot

Returns directory entries grouped by parent path. This is a filesystem listing, not a persistent sandbox backup. Requires a running Firecracker sandbox and sandbox.files.read.

Authorization

bearerAuth
AuthorizationBearer <token>

A RemoteHost API key (rh_sk_...) or a user session token.

In: header

Path Parameters

sandboxId*string

Query Parameters

path?string
depth?integer
Range1 <= value <= 5
Default3

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sandboxes/string/files/snapshot"
{  "path": "string",  "truncated": true,  "directories": {    "property1": [      {        "label": "string",        "path": "string",        "type": "directory"      }    ],    "property2": [      {        "label": "string",        "path": "string",        "type": "directory"      }    ]  }}

Write a sandbox file PUT

Writes at most 2 MiB into the sandbox's /code tree.

The ports a sandbox's environment declares, ready to open GET

The environment's declared ports, read from the environment the sandbox is held to now, each with a team preview minted for the caller, so none has to be requested. Nothing is public: a link for someone outside the org is still POST /sandboxes/{sandboxId}/previews with audience public. Empty for a sandbox with no environment.