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

Get Object

GET
/storage/v1/workspaces/{workspace}/engines/{engine}/buckets/{bucket}/objects/{object_key}
 
curl --request GET \
  --url https://example.com/storage/v1/workspaces/example/engines/example/buckets/example/objects/example

Downloads an object from a bucket via server streaming. The first response message carries metadata, and subsequent messages carry data chunks.

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 containing the object

object_key
required
string

The object key to retrieve

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

GetObjectResponse

Response message for GetObject. Uses gRPC server streaming: the first message carries metadata, and subsequent messages carry data chunks.

object
metadata

Object metadata (only in the first chunk)

object
bucket_id

The bucket this object belongs to

stringOutput only
object_key

The object key (path-like string, no leading slash)

stringOutput only
size

Object size

object
size
required

Size of the object

Is the numerical size of an object

number format: double
unit
required
string format: enum
Allowed values: STORAGE_DATA_UNIT_UNSPECIFIED BYTES KIB MIB GIB TIB PIB EIB KB MB GB TB PB EB
content_type

MIME type (e.g. “application/octet-stream”)

string
etag

Entity tag (checksum)

stringOutput only
last_modified

Timestamp when the object was last modified

stringOutput only
content_md5

Base64-encoded MD5 digest of the object content (nullable for multipart uploads)

stringOutput only
metadata

Arbitrary key-value user metadata

object
key
additional properties
string
storage_class

Storage class or tier (provider-specific string, e.g. STANDARD, GLACIER)

stringOutput only
version_id

Version identifier (format varies by provider)

stringOutput only
engine

The cloud provider this object is stored on.

string format: enum Output only
Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO ENGINE_AWS ENGINE_GCP ENGINE_AZURE
data

Streamed data chunks

string format: bytes
Example 
{
  "metadata": {
    "size": {
      "unit": "STORAGE_DATA_UNIT_UNSPECIFIED"
    },
    "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"
    }
  ]
}