Skip to main content
POST
Begin a version file upload

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

namespace
string
required

The namespace of the repository

repo_name
string
required

The name of the repository

Body

application/json

Body of POST /versions/uploads: the file's hash and size, and where to stage it once it completes.

hash
string
required
size
integer<int64>
required
Required range: x >= 0
destination
object | null

The workspace and path to stage an uploaded file at.

Response

Upload begun, or the file already stored

The answer to POST /versions/uploads.

status
string
required
status_message
string
required
file
enum<string>
required
Available options:
awaiting_parts
num_parts
integer<int64>
required
Required range: x >= 0
part_size
integer<int64>
required
Required range: x >= 0
part_window
integer<int64>
required

How many consecutive parts the upload accepts at once, starting at the first part not yet hashed. A part past them gets 429, so a client sending parts in order keeps at most this many in flight.

Required range: x >= 0
upload_id
string
required
oxen_version
string | null