Skip to main content
POST
Start a sandbox process with secrets
See the secrets guide for SDK and CLI examples.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Sandbox ID.

Body

application/json

Provide secrets, vault, or both.

command
string
required

Shell command to run.

Required string length: 1 - 8192
cwd
string

Working directory.

Maximum string length: 4096
env
object

Plain environment variables. A variable that vault or secrets sets can't also be in env (400 SECRET_SOURCES_INVALID).

timeoutMs
integer

Process timeout in milliseconds.

Required range: 0 <= x <= 86400000
runAs
string

User to run the process as.

Maximum string length: 128
vault
string

Name of a vault whose variables to set. Applied before secrets. Together they set at most 32 variables. A vault without entries returns 400 SECRET_SOURCES_INVALID, and an unknown one 404 VAULT_NOT_FOUND.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{0,127}$
secrets
object

Secrets to set as environment variables for this process only, merged over the vault's variables, so secrets wins on a clash. They aren't added to the sandbox's default environment.

Example:

Response

Success

process
object
required

The started process. Its environment is never returned.

secrets
object[]
required

Each variable the process received, with its source. Never values.