Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Exec a lease
Runs one command in the lease to completion and returns its output, capped at 1 MiB per stream.
Runs one command in the lease to completion and returns its output, capped at 1 MiB per stream. Long-running or interactive processes use the guest protocol at status.endpoints.guest_uri.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/leases/lease:exec - Scope
sandboxes:exec - Effect
write— a successful call changes state. - Collection leases
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the lease. Required. |
command | string[] | The program and its arguments. Use ["bash", "-lc", "…"] for a shell. Required. |
working_directory | string | The working directory; default the user's home. |
env | map<string, string> | Extra environment variables. |
stdin | bytes | Bytes written to standard input. |
timeout | duration | Kill the process after this long; default 60 seconds, at most 10 minutes. |
user | string | The guest user; default user. root is allowed: the whole machine belongs to the lessee. |
#Response
| Field | Type | What it is |
|---|---|---|
exit_code | int32 | The exit code; -1 when killed. |
stdout | bytes | Standard output. |
stderr | bytes | Standard error. |
truncated | bool | Whether either stream exceeded the cap. |
timed_out | bool | Whether the process was killed at timeout. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_STATE— The Resource is in a state that forbids the call.STALE_GENERATION— The call named a lease generation or control epoch that is no longer current.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/leases/lease:exec" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"command":["…"]}'