bus

Create a multipart upload

Creates a new multipart upload and returns an upload ID.

post/bus/multipart/create

Request body

bucketstring

The name of the bucket.

keystring

The key of the object to upload

mimeTypestring

The MIME type of the object

metadataObjectUserMetadata

User-defined metadata about an object provided through X-Sia-Meta- headers

disableClientSideEncryptionboolean

Whether to disable client-side encryption

Example request

{
  "bucket": "default",
  "key": "folder/file",
  "mimeType": "text/plain"
}

Response

Successfully created multipart upload

uploadIDstring byte

The ID of the multipart upload

Example response

{
  "uploadID": "f1e2d3c4b5a697887776665544332211ffeeddccbbaa99887766554433221100"
}

Changes

Changed in 4 of the 50 revisions of this API.43

  • c38282599c5a21See the full diff
    • added ObjectKey subschema #2 to the key request property allOf list

      request-property-all-of-added

    • the key request property type/format changed from string/ to /

      request-property-type-changed

    • the key request property's minLength was decreased from 1 to 0

      request-property-min-length-decreased

  • 922f156353c911See the full diff
    • removed the media type text/plain for the response with the status 500

      response-media-type-removed

    • api tag bus added

      api-tag-added

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 99 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog