Skip to main content
POST
Start a staged upload
Use a staged upload for files larger than 32 MiB. CLI equivalent: ornn volumes files upload <volume> <local-file> --path <remote-path> --yes --idempotency-key <key> --format json.

Authorizations

Authorization
string
header
required

Create an organization API key in Account Settings > Developer. Do not send this key to the Kubernetes API server.

Headers

Idempotency-Key
string

Caller-chosen key of up to 128 characters, unique per upload.

Maximum string length: 128

Path Parameters

drive_id
string<uuid>
required

Volume ID.

Body

application/json
path
string
required

Destination path relative to the volume root.

size_bytes
integer<int64>
required

Exact size of the file you will upload.

Required range: x >= 0
content_type
string
default:application/octet-stream
sha256
string

Optional lowercase or uppercase hex SHA-256 of the file, 64 characters.

Response

The upload session, or state complete for a finished retry.

upload_id
string<uuid>
path
string
method
string

HTTP method for upload_url, currently PUT.

upload_url
string

Short-lived URL that accepts the file bytes. Do not send your Ornn API key to it.

headers
object

Headers to send with the upload.

expires_in_seconds
integer
max_size_bytes
integer<int64>
state
string

complete when a retried key already finished.