Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
Skip to Content
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceComputeSandboxes

List a directory in a sandbox

Lists the entries of a directory inside a sandbox, including each entry's name, type and size, without following symbolic links.

Required permission

Requires the sandboxes.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

Guided workflow: orl sandbox file list

orl sandbox file list <sandbox-id> <dir>
GET
/v1/sandboxes/{sandboxId}/files

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

sandboxId*string

Query Parameters

dir*string

An absolute path in the sandbox.

Response Body

The directory's entries

application/json
  1. response
entries*array<>
Example Request
curl -X GET 'https://api.openrelay.inc/v1/sandboxes/string/files?dir=string'
Example Response
{  "entries": [    {      "path": "string",      "size": 0,      "isDir": true,      "mode": 0,      "modTime": "2019-08-24T14:15:22Z"    }  ]}

Open an interactive terminal in a sandbox GET

Opens an interactive terminal over a WebSocket. Binary frames carry stdin and output; text frames carry resize controls and the exit code. Uses the HTTP/1.1 upgrade; HTTP/2 extended CONNECT (RFC 8441) is not offered. Send {"resize":{"cols":120,"rows":40}} to resize; the last frame received is {"exit":0}.

Read a file from a sandbox GET

Streams the bytes of a regular file at the requested path inside a sandbox. A path that is not a regular file answers 400.