search

Blobs

Manage file blobs.

hashtag
Initiate file upload

post

Initiate a file upload. This endpoint can be used to create resumable uploads.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
filenamestringOptional

The name of the file.

temporarybooleanOptional

When uploading temporary files, set the parameter to true.

Responses
post
/blobs/uploads
No content

hashtag
Upload a chunk of data for the specified upload.

post

Upload a stream of data to upload without completing the upload.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The universally unique identifier (UUID).

Example: 52e51422-573d-4fc9-b5c6-4a30058f5d71
Header parameters
PortSIP-Upload-TokenstringRequired

The upload token of file upload.

Body
string · binaryOptional
Responses
post
/blobs/uploads/{id}/append
No content

hashtag
Complete file upload

post

Complete the upload specified by unique ID, providing all the data in the body, if necessary. A request without a body will just complete the upload with previously uploaded content.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The universally unique identifier (UUID).

Example: 52e51422-573d-4fc9-b5c6-4a30058f5d71
Query parameters
digeststringOptional

The Content Digests. A digest is a serialized hash result, consisting of a algorithm and hex portion. Only sha256 based digest accepted.

Example: 84d89877f0d4041efb6bf91a16f0248f2fd573e6af05c19f96bedb9f882f7882
Header parameters
PortSIP-Upload-TokenstringRequired

The upload token of file upload.

Body
string · binaryOptional
Responses
chevron-right
201

Created

application/json
idall ofOptional

The unique ID of the file.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
post
/blobs/uploads/{id}/complete

hashtag
Get file upload status

get

Retrieve status of upload identified by the unique ID. The primary purpose of this endpoint is to resolve the current status of a resumable upload.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The universally unique identifier (UUID).

Example: 52e51422-573d-4fc9-b5c6-4a30058f5d71
Responses
get
/blobs/uploads/{id}/status
No content

hashtag
Delete file upload

post

Cancel outstanding upload processes, releasing associated resources. If this is not called, the unfinished uploads will eventually timeout.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

The universally unique identifier (UUID).

Example: 52e51422-573d-4fc9-b5c6-4a30058f5d71
Responses
post
/blobs/uploads/{id}/destroy
No content

hashtag
Download file blobs

get

Download file from server by it's digest.

Path parameters
digeststringRequired

The Content Digests. A digest is a serialized hash result, consisting of a algorithm and hex portion. Only sha256 based digest accepted.

Example: 84d89877f0d4041efb6bf91a16f0248f2fd573e6af05c19f96bedb9f882f7882
Responses
get
/blobs/{digest}
PreviousFilesNextTrunks

Last updated