Object Store Management

Get Object Store Metadata

Introduction

Get Object Store metadata of a specific organization and key.

Request

Get Object Store metadata of a specific organization and key. The /object/get API accepts requests in the following format:

GetObjectStoreRequest Model - Request to get Object Store metadata of a specific organization and key.
organizationId string
Organization id we'd like to get the Object Store metadata from.
key string
Key to the Object Store file.
Example 
{
  "organizationId": "string",
  "key": "string"
}

Responses

The /object/get API provides a response in the following format:

200 Success

GetObjectStoreResponse Model - Response received when fetching Object Store metadata.
metadata ObjectStoreMetadata object
Metadata of the Object Store file.
success boolean
Indicate if the API request was successful.
errors string Array
List of errors with the API call.
Example 
{
  "metadata": {
    "key": "Mia/Test",
    "created": "2021-11-26T15:18:27.693Z",
    "modified": "2021-11-26T15:18:27.693Z",
    "size": 13,
    "md5": "5d41402abc4b2a76b9719d911017c592",
    "mime": "text/plain",
    "preview": "Hello, world!"
  },
  "success": true,
  "errors": [
    "string"
  ]
}
ObjectStoreMetadata Model - Metadata of the Object Store file.
key string
example: Mia/Test
Object Store key.
created string($date-time)
Time the file was created.
modified string($date-time)
Time the file was modified.
size float
example: 13
File size.
md5 string
example: 5d41402abc4b2a76b9719d911017c592
MD5 Hash of the file.
mime string
example: text/plain
MIME type.
preview string
example: Hello, world!
Preview of the file content.
Example 
{
  "key": "Mia/Test",
  "created": "2021-11-26T15:18:27.693Z",
  "modified": "2021-11-26T15:18:27.693Z",
  "size": 13,
  "md5": "5d41402abc4b2a76b9719d911017c592",
  "mime": "text/plain",
  "preview": "Hello, world!"
}

401 Authentication Error

UnauthorizedError Model - Unauthorized response from the API. Key is missing, invalid, or timestamp is too old for hash.
www_authenticate string
Header

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: