Skip to main content
POST
Start a multipart upload into a secure files block

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
subUuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

Start a multipart upload. Upload each part with an HTTP PUT to the URLs from getRoomSecureUploadPartUrls (no extra headers), then call completeRoomSecureUpload.

Start a multipart upload. Upload each part with an HTTP PUT to the URLs from getRoomSecureUploadPartUrls (no extra headers), then call completeRoomSecureUpload.

file_name
string
required
Required string length: 1 - 255
size_bytes
integer
required

Exact file size in bytes (max 20 GiB).

Required range: x <= 21474836480
mime_type
string

MIME type of the file. Unrecognised values are stored as application/octet-stream.

Maximum string length: 255
folder_uuid
string<uuid> | null

Destination folder; omit or null for the block root.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

201 - application/json

Default Response

upload_uuid
string
required
part_size
number
required

Bytes per part; every part except the last must be exactly this size.

part_count
number
required
expires_at
string
required

The upload must be completed before this time.