Run a command
Runs a shell command in the App’s sandbox and returns its output after it finishes or times out. The command doesn’t get the App’s Secrets, and its output shows any Secret value as [secret:NAME].
To retry safely, send the same Idempotency-Key. A retry returns the first run’s result instead of running the command again.
Authorizations
Scopes
Headers
A key that identifies this request for retries, up to 200 printable characters. A retry with the same key and input returns the first request's result instead of repeating the work. If you omit the key, the API generates one and returns it in the Idempotency-Key response header.
1 - 200Path Parameters
Body
Response
The command's result.
How the command ended:
completed: the command exited, andexit_codeholds its exit code.timed_out: the command ran pasttimeout_secondsand was stopped.interrupted: the command ended without a result, for example because the sandbox was lost. Its effects are unknown, and it's never run again.
completed, timed_out, interrupted