Signal a background command

Preview. Send a signal to the process group of a background command. 15 (SIGTERM) asks it to stop, and 9 (SIGKILL) ends it. A command that already ended takes no signal, and the answer is the command as it is.

POST
/sandboxes/{sandbox_id}/commands/{command_id}/signal

Authorization

headerAuthorizationBearer <token>

Your Munito API key.

Path Parameters

sandbox_id*string

The id of the sandbox.

command_id*string

The id of the command.

Request Body

application/json
  1. body
signal?integer

The signal number. 15 (SIGTERM) asks the command to stop, and 9 (SIGKILL) ends it.

Range1 <= value <= 64
Default15

Response Body

The command as it is now. A signal reaches it only while it runs.

application/json
  1. response
id*string
command*array<string>

The argument vector that runs.

cwd*string
status*string

running, then exited with an exit code, or failed when the sandbox lost the command.

Value in"running""exited""failed"
started_at*number

Unix seconds.

ended_at?|

Unix seconds, or null while the command runs.

exit_code?|

The exit code, or null while it runs. A command that a signal stopped has 128 plus the signal.

timed_out?boolean
Defaultfalse
stdout?string

Standard output after stdout of the request. A list of commands leaves it out.

Default""
stderr?string

Standard error after stderr of the request. A list of commands leaves it out.

Default""
stdout_bytes?integer

The bytes of standard output so far. Send it as stdout to read only what follows.

Default0
stderr_bytes?integer

The bytes of standard error so far. Send it as stderr to read only what follows.

Default0
truncated?boolean

Each stream keeps 1048576 bytes. The command wrote more, and the rest is left out. Write the output to a file for more.

Defaultfalse
curl -X POST 'https://api.munito.ai/sandboxes/v1/sandboxes/string/commands/string/signal' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "id": "string",
  "command": [
    "string"
  ],
  "cwd": "string",
  "status": "running",
  "started_at": 0,
  "ended_at": 0,
  "exit_code": 0,
  "timed_out": false,
  "stdout": "",
  "stderr": "",
  "stdout_bytes": 0,
  "stderr_bytes": 0,
  "truncated": false
}