API Reference

Create a connect token for a sandbox run

post
https://api.render.com/v1/sandboxes//runs//token

Mint a short-lived, capability-scoped connect token that authorizes a
single run operation against the specified sandbox. The response contains
the sandbox URI where the caller sends the command with the token as a bearer credential.

409 with code: sandbox_group_suspended if the sandbox group is suspended.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^sbx-[0-9a-v]{25}$

The ID of the sandbox

string
enum
required

The run operation to authorize — sync (buffered) or stream (server-sent events).

Allowed:
Query Params
string

The ID of the workspace the sandbox belongs to. Optional: the workspace is
determined from the sandbox ID, and this parameter is ignored when supplied.

Body Params

Optional body when minting a run connect token. command is stored on
the exec timeline (truncated to 4KB); the full command is still sent
to the sandbox proxy when executing.

string

Command text for the sandbox event timeline.

Responses

Updated about 9 hours ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 9 hours ago