Class SandboxClient

Creates a directory in a sandbox, including missing parents by default.

Creates a new Sandbox.

Deletes a file, symlink, or empty directory, with an option for recursive deletion. Succeeds if the path is already absent.

Deletes a Sandbox.

Downloads a regular file from a sandbox as an application/octet-stream body. The sandbox starts automatically if it is stopped. Filesystem access uses the sandbox user's permissions and follows symbolic links.

A full download returns 200 OK. A satisfiable single byte range returns 206 Partial Content. Multiple byte ranges are unsupported and return 400. Invalid ranges are ignored; an unsatisfiable range returns 416 with Content-Range describing the file length. Range is ignored for empty files.

Conditional requests can return 304 Not Modified or 412 Precondition Failed. If-Range selects a partial response only when its strong entity tag matches; otherwise, the entire file is returned. HTTP-date validators in If-Range cause a full download. Reads are not snapshots: concurrent in-place writes can affect the returned bytes. HEAD is unsupported.

Range and conditional options may be supplied as query parameters or HTTP headers. A parameter and one header may both be supplied when their values match exactly. Conflicting values or repeated parameters return 400.

Runs a command in the sandbox and blocks until it exits, returning the captured stdout, stderr and exit code in a single response.

Returns metadata for a path without following its final symlink.

Retrieves a Sandbox by name.

Lists the tracked command executions (running and completed) in a sandbox.

Lists a directory's immediate children in UTF-8 name order. Later pages may reflect concurrent changes.

Lists all Sandboxes.

Renames a path within a sandbox. The destination must be absent and on the same filesystem.

Starts a previously stopped Sandbox under the same sandbox name. Returns NOT_FOUND if there is no stopped sandbox to start for the given name.

Stops a running Sandbox, preserving it so it can later be restarted with a Start request.

Updates mutable fields on an existing Sandbox. Allowlisted update_mask paths today: display_name, spec.compute.inactivity_timeout. Returns INVALID_PARAMETER_VALUE for empty masks or unknown paths; NOT_FOUND if the sandbox does not exist.

Uploads an application/octet-stream body to a sandbox. The sandbox starts automatically if it is stopped. Filesystem access uses the sandbox user's permissions. Replacements follow symbolic links.

Creates the file or replaces its entire contents, creating parent directories if missing. The completed upload becomes visible atomically. A failure before commit leaves an existing destination unchanged; a lost response after commit does not undo the upload. Completion does not guarantee crash durability.

Returns 201 Created for a new file or 204 No Content for a replacement. Set overwrite=false or supply If-None-Match: * to create a file only if the destination does not exist. An existing entry, including a symbolic link, returns 412 Precondition Failed. Conflicting options or repeated overwrite parameters return 400. Other If-None-Match values, Content-Range, If-Match, and If-Unmodified-Since are unsupported and return 400.