Object Store Management

Get Object Store Metadata

Introduction

Get Object Store properties of a specific organization and key. It does not work if the object store is a directory.

Request

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

GetObjectStorePropertiesRequest Model - Request to get Object Store properties of a specific organization and keys.
organizationId string
Organization ID we would like to get the Object Store properties from.
key string
Key to the Object Store.
Example 
{
  "organizationId": "string",
  "key": "string"
}

Responses

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

200 Success

GetObjectStorePropertiesResponse Model - Response received when fetching Object Store file properties.
metadata ObjectStoreProperties object
Object Store file properties.
success boolean
Indicate if the API request was successful.
errors string Array
List of errors with the API call.
Example 
{
  "metadata": {
    "key": "string",
    "modified": "2021-11-26T15:18:27.693Z",
    "created": "string",
    "size": 24,
    "md5": "string",
    "mime": "string",
    "preview": "string"
  },
  "success": true,
  "errors": [
    "string"
  ]
}
ObjectStoreProperties Model - Object Store file properties.
key string
Object Store key.
modified string($date)
Last time it was modified.
created string
Date this project was created.
size float
example: 24
Object Store file size.
md5 string
MD5 (hashing algorithm) hash authentication code.
mime string
MIME type.
preview string
Preview of the Object Store file content.
Example 
{
  "key": "string",
  "modified": "2021-11-26T15:18:27.693Z",
  "created": "string",
  "size": 24,
  "md5": "string",
  "mime": "string",
  "preview": "string"
}

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: