Skip to main content
Create a volume file upload

Authorizations

Authorization
string
header
required

BoxRouter API key; never an upstream provider key.

Headers

Idempotency-Key
string

Optional for this operation. Preserve the same stable identifier when retrying an uncertain response; never reuse it for new work. If omitted where allowed, Cloud generates a request-scoped key that cannot reconcile a later retry. Do not include credentials or payloads. Stable identifier for one logical mutation.

Required string length: 1 - 128

Path Parameters

volume_id
string
required

BoxRouter-managed Volume ID. Provider-native volume requirements are not accepted.

Pattern: ^vol_[0-9a-f]{32}$

Body

application/json
path
string
required

Relative path from the volume root, visible in sandboxes at /workspace/<path>. Empty paths, a leading slash, empty, . or .. segments, NUL, and paths longer than 1024 UTF-8 bytes are refused with invalid_request (400).

Required string length: 1 - 1024
Pattern: ^(?!/)(?!.*//)(?!\.{1,2}(?:/|$))(?!.*\/\.{1,2}(?:/|$))(?!.*\u0000).+$
size
integer
required

File size in bytes, from zero through 5 TiB. Even an empty file uses one multipart part.

Required range: 0 <= x <= 5497558138880

Response

Created multipart upload

Multipart upload session. Upload each part URL with an HTTP PUT containing exactly the part bytes, then pass each response ETag header to complete. Part URLs and this session expire together, six hours after creation plus about one hour for each 70 GiB of the declared size, at most 72 hours. The file appears at /workspace/<path> in sandboxes after completion. An open upload blocks write sandboxes; write attachments block creating uploads. Read and shared sandboxes may need to refresh their volume cache to see the new file.

id
string
required
Pattern: ^vup_[0-9a-f]{32}$
volume_id
string
required

BoxRouter-managed Volume ID. Provider-native volume requirements are not accepted.

Pattern: ^vol_[0-9a-f]{32}$
path
string
required

Relative path from the volume root, visible in sandboxes at /workspace/<path>. Empty paths, a leading slash, empty, . or .. segments, NUL, and paths longer than 1024 UTF-8 bytes are refused with invalid_request (400).

Required string length: 1 - 1024
Pattern: ^(?!/)(?!.*//)(?!\.{1,2}(?:/|$))(?!.*\/\.{1,2}(?:/|$))(?!.*\u0000).+$
size
integer
required
Required range: 0 <= x <= 5497558138880
part_size
integer
required
Required range: x >= 1
parts
object[]
required
Required array length: 1 - 10000 elements
expires_at
string<date-time>
required