Head Object
const url = 'https://example.com/storage/v1/workspaces/example/engines/example/buckets/example/objects/example:metadata';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/storage/v1/workspaces/example/engines/example/buckets/example/objects/example:metadataReturns a stored file’s record without downloading its content.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The workspace the bucket belongs to
The cloud provider: qibdo, aws, gcp, or azure
The bucket containing the object
The full name of the object to describe
Responses
Section titled “ Responses ”OK
Blob
A stored file. Population varies BY RPC: a provider’s list call returns an index, not the full record — absent means “not carried by this RPC on this provider”, never fabricated-empty.
object
The bucket that actually holds this file, as its platform identifier. Resolvable via GetBucket. Empty when the read path could not name the parent row.
Absent on a listing row; populated on Head/Get.
Change-detection token. Guaranteed only to change when the object changes.
NOT a content digest — providers compute it differently for multipart,
composite and encrypted objects, and one provider returns different values
for the same object across its own APIs. Use checksums for integrity.
Integrity digests, each carrying its own algorithm. May be empty: some objects genuinely have none. On a listing row emptiness is NOT proof of absence — see ListObjectsResponse.unpopulated_fields.
Checksum
One integrity digest.
object
An algorithm the platform catalogues.
The provider’s own algorithm token, verbatim, when the platform does not yet catalogue it. Read-side honesty only — a caller may never supply this arm.
Empty on a listing row; populated on Head/Get. Emptiness on a listing row is NOT proof of absence — see ListObjectsResponse.unpopulated_fields.
object
Absent on a listing row; populated on Head/Get.
Where a provider reports a single timestamp (the S3 family reports LastModified alone), create_time is ABSENT rather than a copy of update_time.
Example
{ "checksums": [ { "catalogued": "CHECKSUM_ALGORITHM_UNSPECIFIED" } ]}default
Section titled “default ”Default error response
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
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
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.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}