SFTPGo Octri Preview
POST/shares-chunked-uploads

Create Upload (Creation)

Initializes a new upload resource. The server will respond with a Location header containing the specific URL to send data chunks to via PATCH. Password-protected shares require HTTP Basic authentication (the share password as the BasicAuth password); the same credentials must be re-sent on every subsequent HEAD and PATCH request for the upload. Available when the binding's upload_chunk_size is greater than zero.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 parameters
Tus-Resumablestringrequired
TUS protocol version.
Allowed:1.0.0
Upload-Lengthintegerrequired
The total size of the file in bytes.
Upload-Metadatastringrequired
File metadata encoded as Key/Value pairs. Format: `key Base64Value,key2 Base64Value`. **Mandatory Fields:** - `path`: The absolute destination path (e.g., `/folder/file.txt`). - `share_id`: Public Share ID. **Optional Fields:** - `mtime`: Last modification timestamp (Unix/String). - `mkdir_parents`: Set to "true" to automatically create parent directories.

4 status codes
201Upload created successfully.
400Missing headers or malformed metadata (e.g., missing 'path').
401Unauthorized (Invalid Token or Cookie).
413The file exceeds the maximum allowed size.

Error handling

A 400 is returned: Missing headers or malformed metadata (e.g., missing 'path'). A 401 is returned: Unauthorized (Invalid Token or Cookie). A 413 is returned: The file exceeds the maximum allowed size.