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

Generate Upload URL

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

Generates a pre-signed PUT URL for uploading an object directly to the storage data plane.

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: qibdo, aws, gcp, or azure

bucket
required
string

The bucket to generate the upload URL for

Request Body required

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

GenerateUploadUrlRequest

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

object
workspace
required

The workspace the bucket belongs to

string
engine
required

The cloud provider: qibdo, aws, gcp, or azure

string
bucket
required

The bucket to generate the upload URL for

string
object_key
required

The object key for the upload

string
content_type

Optional MIME type restriction for the upload

string
expiry

URL validity duration (default 1h, max 24h)

string
/^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$/
Example generated
{
  "workspace": "example",
  "engine": "example",
  "bucket": "example",
  "object_key": "example",
  "content_type": "example",
  "expiry": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

PresignedUrlResponse

Response message for GenerateUploadUrl and GenerateDownloadUrl. Carries the pre-signed URL, its expiry timestamp, and the cloud provider the URL targets.

object
url

The pre-signed URL (direct to the storage data plane)

string
expiry_time

ISO 8601 timestamp when the URL expires

string
engine

The cloud provider this URL targets

string format: enum Output only
Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO ENGINE_AWS ENGINE_GCP ENGINE_AZURE
Example 
{
  "engine": "ENGINE_UNSPECIFIED"
}

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"
    }
  ]
}