package modal.task_command_router
Get desktop application:
View/edit binary Protocol Buffers messages
message
task_command_router.proto:39string task_id = 1
uint64 offset = 2
bytes data = 3
bool eof = 4
message
task_command_router.proto:46(message has no fields)
rpc SandboxStdioReadV2 (, stream )
task_command_router.proto:373message
task_command_router.proto:48string task_id = 1
uint64 offset = 2
SandboxStdioFileDescriptor file_descriptor = 3
message
task_command_router.proto:54bytes data = 1
uint64 starting_offset = 2
message
task_command_router.proto:59string task_id = 1
float timeout = 2
message
task_command_router.proto:64double ready_at = 1
Create an additional container for a task.
message
task_command_router.proto:68string task_id = 1
string container_name = 2
Logical container name.
string image_id = 3
repeated string args = 5
map<string, string> env = 6
string workdir = 7
repeated string secret_ids = 8
Secret IDs to inject into the container as environment variables.
repeated volume_mounts = 9
Volumes to mount into the container.
optional network_access = 10
Outbound network policy for the sidecar, independent of the main container. When unset, defaults to open network access. BLOCKED is not accepted: a blocked sidecar has no IP and cannot reach the main container.
message
task_command_router.proto:86string container_id = 1
Fully qualified container ID (for example, ctr-<ulid>).
string container_name = 2
Logical container name associated with this container.
Get the latest container associated with a logical name.
message
task_command_router.proto:93string task_id = 1
string container_name = 2
bool include_terminated = 3
Include the latest terminated container if the name is no longer active.
message
task_command_router.proto:100optional container = 1
List containers associated with the task.
message
task_command_router.proto:111string task_id = 1
bool include_terminated = 2
Include all tracked terminated containers in addition to active ones.
message
task_command_router.proto:117repeated containers = 1
Terminate or release a tracked container.
message
task_command_router.proto:121string task_id = 1
string container_id = 2
message
task_command_router.proto:126(message has no fields)
Wait for a tracked container to reach a terminal result.
message
task_command_router.proto:128string task_id = 1
string container_id = 2
float timeout = 3
message
task_command_router.proto:134optional result = 1
Poll for the exit status of an exec'd command.
message
task_command_router.proto:138string task_id = 1
The ID of the task running the exec'd command.
string exec_id = 2
The execution ID of the command to wait on.
message
task_command_router.proto:147The response to a TaskExecPollRequest. If the exec'd command has not completed, exit_status will be unset.
oneof exit_status
int32 code = 1
The exit code of the command.
int32 signal = 2
The signal that terminated the command.
Execute a command in the task.
message
task_command_router.proto:158string task_id = 1
The ID of the task to execute the command in.
string exec_id = 2
Execution ID. This ID will be used to identify the execution for other requests and ensure exec commands are idempotent.
repeated string command_args = 3
Command arguments to execute.
TaskExecStdoutConfig stdout_config = 4
Configures how the stdout of the command will be handled.
TaskExecStderrConfig stderr_config = 5
Configures how the stderr of the command will be handled.
optional uint32 timeout_secs = 6
Timeout in seconds for the exec'd command to exit. If the command does not exit within this duration, the command will be killed. This is NOT the timeout for the ExecStartRequest RPC to complete.
optional string workdir = 7
Working directory for the command.
repeated string secret_ids = 8
Secret IDs to mount into the task.
optional pty_info = 9
PTY info for the command.
bool runtime_debug = 10
Enable debugging capabilities on the container runtime. Used only for internal debugging.
string container_id = 11
Fully qualified target container ID. Empty targets the main container.
map<string, string> env = 12
Environment variables to set directly for the exec'd command.
message
task_command_router.proto:189(message has no fields)
Get the current stdin write status for an exec'd command. Used to resume a TaskExecStdinWriteStream after a stream failure. Evicts any in-flight TaskExecStdinWriteStream for this exec, so it is not safe to call for read-only observability.
message
task_command_router.proto:191string task_id = 1
The ID of the task running the exec'd command.
string exec_id = 2
The execution ID of the command to query.
message
task_command_router.proto:198uint64 num_bytes_written = 1
Number of bytes the server has accepted for this exec so far. A streaming client that lost its connection should resume sending at this offset.
bool closed = 2
True if stdin has already been closed (EOF sent) for this exec.
Write to the stdin stream of an exec'd command.
message
task_command_router.proto:207string task_id = 1
The ID of the task running the exec'd command.
string exec_id = 2
The execution ID of the command to write to.
uint64 offset = 3
The offset to start writing to. This is used to resume writing from the last write position if the connection is closed and reopened.
bytes data = 4
bool eof = 5
If true, close the stdin stream after writing any provided data. This signals EOF to the exec'd process.
message
task_command_router.proto:221(message has no fields)
rpc TaskExecStdinWriteStream (stream , )
task_command_router.proto:398Stream stdin bytes to an exec'd command. First message carries the start message (task_id, exec_id, offset); subsequent messages carry data.
message
task_command_router.proto:225oneof payload
First message must be `start`; subsequent messages are `data`; a final `end` signals EOF.
start = 1
Start of a stdin write stream. Includes task_id, exec_id, and offset to write to.
bytes data = 2
A chunk of stdin data to write to the exec'd command.
end = 3
Signals EOF: close stdin after the data sent so far.
message
task_command_router.proto:238(message has no fields)
rpc TaskExecStdioRead (, stream )
task_command_router.proto:400Get a stream of output from the stdout or stderr stream of an exec'd command.
message
task_command_router.proto:249string task_id = 1
The ID of the task running the exec'd command.
string exec_id = 2
The execution ID of the command to read from.
uint64 offset = 3
The offset to start reading from. This is used to resume reading from the last read position if the connection is closed and reopened.
TaskExecStdioFileDescriptor file_descriptor = 4
Which file descriptor to read from.
message
task_command_router.proto:261bytes data = 1
The data read from the file descriptor.
Wait for an exec'd command to exit and return the exit code.
message
task_command_router.proto:266string task_id = 1
The ID of the task running the exec'd command.
string exec_id = 2
The execution ID of the command to wait on.
message
task_command_router.proto:273oneof exit_status
int32 code = 1
The exit code of the command.
int32 signal = 2
The signal that terminated the command.
Mount an image at a directory in the container.
message
task_command_router.proto:284string task_id = 1
bytes path = 2
string image_id = 3
optional bytes customer_supplied_encryption_key = 4
Customer-supplied encryption key used to decrypt CSEK-encrypted image metadata keys. This key is not persisted by Modal.
Reload all Volumes mounted in the task to reflect their latest committed state.
message
task_command_router.proto:293string task_id = 1
string container_id = 2
Fully qualified target container ID. Empty targets the main container.
message
task_command_router.proto:299(message has no fields)
Replace the task's outbound network allowlist (domains + CIDRs).
message
task_command_router.proto:301string task_id = 1
optional network_access = 2
Replaces the task's network access policy. Only ALLOWLIST is currently supported; open access is expressed as an allow-all allowlist.
message
task_command_router.proto:308(message has no fields)
Snapshot a directory with a mounted image, including any local changes, into a new image.
message
task_command_router.proto:310string task_id = 1
bytes path = 2
string snapshot_id = 3
A unique ID to ensure idempotency of directory snapshot requests.
optional int64 ttl_seconds = 4
Lifetime for the resulting image, in seconds. When set, the image's expires_at is a hard cutoff: it is fixed at creation time and is not extended on use. When unset, the resulting image gets the legacy retention policy: a 30-day TTL that is bumped forward by 30 days on every use, so active images effectively never expire. Sentinel: -1 means "no expiry" (the image never expires). 0 and other negative values are invalid and rejected by the server.
optional bytes customer_supplied_encryption_key = 5
Customer-supplied encryption key used to encrypt the resulting image's data and tree metadata keys. This key is not persisted by Modal.
message
task_command_router.proto:332string image_id = 1
Snapshot the full task filesystem into a new image.
message
task_command_router.proto:336string task_id = 1
string snapshot_id = 2
A unique ID to ensure idempotency of filesystem snapshot requests.
optional int64 ttl_seconds = 3
Lifetime for the resulting image, in seconds. Must be set. When positive, the image expiry is a hard cutoff: it is fixed at creation time and is not extended on use. Sentinel: -1 means "no expiry" (the image never expires). 0 and other negative values are invalid and rejected by the server.
optional bytes customer_supplied_encryption_key = 4
Customer-supplied encryption key used to encrypt the resulting image's data and tree metadata keys. This key is not persisted by Modal.
message
task_command_router.proto:353string image_id = 1
Take a memory snapshot of the task's sandbox container. Idempotency is keyed on the request idempotency_key: concurrent and repeated calls with the same key share one snapshot attempt. A successful snapshot currently terminates the container.
message
task_command_router.proto:357string task_id = 1
string idempotency_key = 2
message
task_command_router.proto:362string snapshot_id = 1
Unmount an image previously mounted at a directory in the container.
message
task_command_router.proto:366string task_id = 1
bytes path = 2
Used in:
SANDBOX_STDIO_FILE_DESCRIPTOR_STDOUT = 0
SANDBOX_STDIO_FILE_DESCRIPTOR_STDERR = 1
message
task_command_router.proto:104Used in: ,
string container_id = 1
string container_name = 2
string status = 3
optional result = 4
Used in:
TASK_EXEC_STDERR_CONFIG_DEVNULL = 0
The output will be discarded.
TASK_EXEC_STDERR_CONFIG_PIPE = 1
The output will be streamed to the client.
TASK_EXEC_STDERR_CONFIG_STDOUT = 2
A special value that can be used to indicate that the stderr stream should be merged with the stdout stream.
message
task_command_router.proto:223Used in:
(message has no fields)
message
task_command_router.proto:240Used in:
string task_id = 1
The ID of the task running the exec'd command.
string exec_id = 2
The execution ID of the command to write to.
uint64 offset = 3
The byte offset at which the stream begins. Will be 0 unless resuming a broken stream.
Used in:
TASK_EXEC_STDIO_FILE_DESCRIPTOR_STDOUT = 0
Read from stdout.
TASK_EXEC_STDIO_FILE_DESCRIPTOR_STDERR = 1
Read from stderr.
Used in:
TASK_EXEC_STDOUT_CONFIG_DEVNULL = 0
The output will be discarded.
TASK_EXEC_STDOUT_CONFIG_PIPE = 1
The output will be streamed to the client.