Devbox
Devbox-ShellTools

Kill an asynchronous execution currently running on a devbox

Changed on

Kill a previously launched asynchronous execution if it is still running by killing the launched process. Optionally kill the entire process group.

post/v1/devboxes/{devbox_id}/executions/{execution_id}/kill

Request

  • Base URL: https://api.runloop.ai
  • URL: https://api.runloop.ai/v1/devboxes/{devbox_id}/executions/{execution_id}/kill
  • Auth: HTTP bearer

Path parameters

devbox_idstring required

The Devbox ID.

execution_idstring required

The Async Execution ID.

Request body

kill_process_groupboolean nullable

Whether to kill the entire process group (default: false). If true, kills all processes in the same process group as the target process.

Response

OK

devbox_idstring required

Devbox id where command was executed.

execution_idstring required

Ephemeral id of the execution in progress.

status'queued' | 'running' | 'completed' required
shell_namestring nullable

Shell name.

stdoutstring nullable

Standard out generated by command. This field will remain unset until the execution has completed.

stderrstring nullable

Standard error generated by command. This field will remain unset until the execution has completed.

exit_statusinteger nullable

Exit code of command execution. This field will remain unset until the execution has completed.

stdout_truncatedboolean nullable

Indicates whether the stdout was truncated due to size limits.

stderr_truncatedboolean nullable

Indicates whether the stderr was truncated due to size limits.

Changes

  • d3ddb452754cRevision changes
    • breaking

      the request property became not nullable

  • 63df0e3eb49dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status