Skip to content

OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.

Skip to Content

Pricing Dashboard

Guides API Reference CLI

Pricing Dashboard

Using the API

Introduction Errors Pagination

Account and access

Compute

Overview List active sandboxes or history GET Create a sandbox POST Get a sandbox GET Kill a sandbox DELETE Run a command in a sandbox POST Open an interactive terminal in a sandbox GET List a directory in a sandbox GET Read a file from a sandbox GET Write a file into a sandbox PUT Expose a port of a sandbox at a public URL POST Stop exposing a port of a sandbox DELETE Answer a fresh signed URL for a signed port POST Pause a sandbox POST Resume a paused sandbox POST Create many sandboxes as one group POST Get a sandbox group GET List sandbox templates GET Create a sandbox template POST Get a sandbox template GET Get the organization's sandbox network policy GET Replace sandbox network policy PUT Get a member's sandbox network policy GET Delete a member's sandbox network policy DELETE Replace a member's sandbox network policy PUT Get an API key's sandbox network policy GET Delete an API key's sandbox network policy DELETE Replace an API key's sandbox network policy PUT Get the current sandbox fleet observation GET

Billing and usage

Providers

Inference

API ReferenceComputeSandboxes

Overview

Sandboxes: isolated virtual machines that start in milliseconds, run a command and stop, with files, ports and an interactive terminal. Served at the API endpoint (api.openrelay.inc); a sandbox's exposed ports answer on its own host under sandbox.openrelay.inc. Sandbox access is enabled per organization; without it these endpoints return 404.

Sandboxes

Sandboxes: isolated virtual machines that start in milliseconds, run a command and stop, with files, ports and an interactive terminal. Served at the API endpoint (api.openrelay.inc); a sandbox's exposed ports answer on its own host under sandbox.openrelay.inc. Sandbox access is enabled per organization; without it these endpoints return 404.

Answer a fresh signed URL for a signed port

Create a sandbox

Create a sandbox template

Create many sandboxes as one group

Delete a member's sandbox network policy

Delete an API key's sandbox network policy

Expose a port of a sandbox at a public URL

Get a member's sandbox network policy

Get a sandbox

Get a sandbox group

Get a sandbox template

Get an API key's sandbox network policy

Get the current sandbox fleet observation

Get the organization's sandbox network policy

Kill a sandbox

List a directory in a sandbox

List active sandboxes or history

List sandbox templates

Open an interactive terminal in a sandbox

Pause a sandbox

Read a file from a sandbox

Replace a member's sandbox network policy

Replace an API key's sandbox network policy

Replace sandbox network policy

Resume a paused sandbox

Run a command in a sandbox

Stop exposing a port of a sandbox

Write a file into a sandbox

Locations / regions GET

Returns the catalog of locations (regions), each with an id, name, city, country, and region, plus latitude and longitude when they are set.

List active sandboxes or history GET

List active sandboxes by default, including paused sandboxes. Select history to see non-ephemeral sandboxes that ended in the last 24 hours. Active sandboxes are ordered newest first. Set state=exited for history, ordered by end time. Pages query the selected view before pagination. A record can lag a running sandbox by a few seconds; getSandbox answers from the host.

On this page