Documents

Get a signed URL to upload a .zip or .pst container

Changed on

Returns a URL the client PUTs the container's bytes to, with the returned Content-Type. Then start its expansion with POST /documents/containers. On cloud storage the URL is the store's own signed URL and the bytes never pass through the API; on local storage the API streams them to disk. Either way the API never holds the container.

post/api/v0/documents/containers/upload-url

Request

Request body

namestring required

The container's file name; its extension must be .zip or .pst.

sizeinteger required

The container's size in bytes.

Response

Successful Response

upload_idstring uuid required

Names this upload when expansion is started with POST /documents/containers.

urlstring required

The signed URL to PUT the container's bytes to.

content_typestring required

The Content-Type header the PUT must carry. On S3 and GCS the URL is signed for this value, and storage refuses a PUT that sends another.

Changes