Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Initiate Multipart Upload

POST
/storage/v1/workspaces/{workspace}/engines/{engine}/buckets/{bucket}/multipart-uploads
 
curl --request POST \
  --url https://example.com/storage/v1/workspaces/example/engines/example/buckets/example/multipart-uploads \
  --header 'Content-Type: application/json' \
  --data '{ "workspace": "example", "engine": "example", "bucket": "example", "object_key": "example", "content_type": "example" }'

Starts a new multipart upload on the given cloud provider and returns an upload ID.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace
required
string

The workspace the bucket belongs to

engine
required
string

The cloud provider to initiate the upload on: qibdo, aws, gcp, or azure

bucket
required
string

The bucket to initiate the upload in

Request Body required

Section titled “Request Body required ”
Media type application/json

InitiateMultipartUploadRequest

Request message for InitiateMultipartUpload. Carries the parent workspace and bucket, the target cloud provider, the object key, and an optional content type.

object
workspace
required

The workspace the bucket belongs to

string
engine
required

The cloud provider to initiate the upload on: qibdo, aws, gcp, or azure

string
bucket
required

The bucket to initiate the upload in

string
object_key
required

The object key for the multipart upload

string
content_type

Optional MIME type for the final object

string
Example generated
{
  "workspace": "example",
  "engine": "example",
  "bucket": "example",
  "object_key": "example",
  "content_type": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

InitiateMultipartUploadResponse

Response message for InitiateMultipartUpload. Carries the generated upload ID, the object key, and the bucket name.

object
upload_id

The generated upload ID

string
object_key

The object key

string
bucket

The bucket name

string
Example generated
{
  "upload_id": "example",
  "object_key": "example",
  "bucket": "example"
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}