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

Read a file from a sandbox

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

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 read

orl sandbox file read <sandbox-id> <path>
GET
/v1/sandboxes/{sandboxId}/files/content

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

sandboxId*string

Query Parameters

path*string

An absolute path in the sandbox.

Response Body

The file's bytes

response?fileapplication/octet-stream
Formatbinary
Example Request
curl -X GET 'https://api.openrelay.inc/v1/sandboxes/string/files/content?path=string'
Example Response
"string"

List a directory in a sandbox GET

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

Write a file into a sandbox PUT

Writes bytes to a file inside a sandbox, creating or replacing it. The parent directory must exist; repeating the same write is safe. The request body is written to path, created if missing and truncated if not. A client may retry the same bytes after a lost connection.