Skip to main content
POST
Create a resumable volume upload session

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Headers

Idempotency-Key
string
required

Reuse the same key to safely retry the same create, reusable snapshot create, fork, upload create/complete, or agent deployment create operation without duplicating work.

Path Parameters

id
string
required

Volume ID

Body

application/json
kind
enum<string>
required
Available options:
file,
directory_tar
source_kind
enum<string>
required
Available options:
restartable_file,
spooled_stream,
directory_archive
target_path
string
required

Requested upload destination path rooted at /. Relative paths are rejected and .. may not escape the volume root.

content_length
integer<uint64>
required
conflict
enum<string>
required
Available options:
merge,
replace,
error
checksum_algorithm
enum<string>
required
Available options:
sha256
archive_format
enum<string>
Available options:
tar
whole_checksum_sha256
string
metadata
object

Free-form client-supplied metadata for the upload session; stored verbatim, deliberately open.

Response

Upload session created

session
object
required