files

Unpack a tar archive of up to 1 MiB into a folder, from the raw request body.

The folder and its parents are made; the archive merges into what is there, replacing files of the same name. gzip is recognised by its first bytes. Larger archives: POST .../files/archive/uploads (the SDKs switch for you). Needs write_file.

put/v1/sandboxes/{id}/files/archive

Request

  • Base URL: https://api.withruntime.com
  • URL: https://api.withruntime.com/v1/sandboxes/{id}/files/archive
  • Auth: HTTP bearer

Path parameters

idstring required

Resource identifier (UUID).

Query parameters

pathstring

The folder, absolute, e.g. /workspace/app. An upload makes it and its parents, and merges into what is there.

user'sandbox' | 'root'

Run tar as the sandbox user, or as root through passwordless sudo.

Headers

Idempotency-Keystring

Replaying the same key with the same request within 24 hours returns the first result and never repeats the effect. A refusal is not kept: a request refused before it ran (no_capacity, busy, a limit) runs afresh when sent again with its key. The SDKs send one automatically; the server makes one when absent and returns it in the idempotency-key response header.

Response

Success

pathstring required
receivedinteger required

Bytes of archive unpacked.

Changes

No recorded changes to this operation across all 1 revision of this API.