Sign in

Get object

Returns an object's metadata or full object data.

get/bus/object/{key}

Path parameters

keystring required
Example:myDir/myFile

The key of the object to fetch

Query parameters

bucketstring required

The name of the bucket.

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

{
  "etag": "W/\"33a64df551425fcc55e4d42a148795d9f25f89d4\""
}

Changes