bus

Get object

Changed on

Returns an object's metadata or full object data.

get/bus/object/{key}

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

keystring required
Example:folder/file

The key of the object to fetch

Query parameters

bucketstring required

The name of the bucket.

Example:default

The name of the bucket the object is in

onlymetadataboolean

If true, only returns object metadata without data

Response

Successfully retrieved object

metadataObjectUserMetadata

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

bucketstring

The name of the bucket.

etagstring

The ETag of the object

healthnumber float

The health of the object

modTimestring date-time

When the object was last modified

keystring

The key of the object

sizeinteger

The size of the object in bytes

mimeTypestring

The MIME type of the object

encryptionKeystring

A key used to encrypt and decrypt data. The key is either a regular key (key) or a salted key (skey). The latter requires a seed to be used for encryption and decryption.

Example response

{
  "bucket": "default",
  "etag": "W/\"33a64df551425fcc55e4d42a148795d9f25f89d4\""
}

Changes

  • c38282599c5aRevision changes
    • breaking

      the //// response's property type changed from integer to no type, and format from uint8 to no format for status

    • info

      removed the pattern .* from the path request parameter key

    • info

      for the path request parameter key, the type was generalized from string to no type

    • info

      added subschema #2 to the //// response property allOf list for the response status

  • 922f156353c9Revision changes
    • breaking

      removed the media type text/plain for the response with the status

    • info

      api tag bus added

    • info

      added the non-success response with the status