Storage Objects

Download a file or get upload session status

Changed on

Download a file, or get the status of a resumable upload session.

File Download (default): Downloads the file at the specified path.

Session Status (with X-Upload-Session header): Returns the status of a resumable upload session, including which parts have been uploaded. Anonymous sessions must reuse the exact anon key that created the session.

get/storage/{bucketName}/{path}

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/storage/{bucketName}/{path}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

bucketNamestring required

Storage bucket name

pathstring required

Object path within bucket

Headers

Rangestring

HTTP Range header for partial downloads. Format: bytes=start-end or bytes=start- Examples: bytes=0-1023, bytes=1000-

X-Upload-Sessionstring

Upload session ID (to get session status instead of downloading)

Response

File content or session status

session_idstring

Upload session ID

status'pending' | 'uploading' | 'completing' | 'completed' | 'aborted'

Current status of the upload

pathstring

Target file path

content_typestring

MIME type

total_sizeinteger

Total file size in bytes

part_sizeinteger

Size of each part (except last)

total_partsinteger

Total number of parts

parts_uploadedinteger

Number of parts uploaded

bytes_uploadedinteger

Total bytes uploaded so far

expires_atstring date-time

Session expiry time

created_atstring date-time

Session creation time

Changes

    • ▲

      added the new path request parameter bucketName

    • ▲

      the response's body type changed from no type to object for status

    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ▲

      the response's body type changed from object to no type for status

    • ▲

      the response's body type changed from object to no type for status

    • ▲

      removed the required property from the response with the status

    • ●

      deleted the path request parameter bucketName

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status

    • ●

      removed the optional property from the response with the status