Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-178042197.1 KB
Service

Storage Backend Information

Provide information about the storage backends available on this service instance. These are populated on deployment of the service instance.

get/service/storage-backends

Response

store_type'http_object_store' required

The generic Storage Backend type. Used to identify the required workflow for reading and writing media. Any store_product should be compatible, as much is required for basic interoperability between TAMS implementations, with their associated generic store_type.

providerstring required

The cloud (or other) provider of the Storage Backend

regionstring

The region in the cloud this Storage Backend resides

availability_zonestring

The availability zone in the cloud region this Storage Backend resides. Note that many cloud providers randomize availability zone identifiers such that they are consistent within a cloud account, but not necessarily between accounts. Caution should be exercised when using this parameter.

store_productstring required

The storage product name.

idstring required

A Universally Unique Identifier (UUID) as defined in RFC9562

labelstring

Freeform string label for a storage backend.

default_storageboolean

If set to true, this is the default storage backend. The default storage backend will be used if the client does not specify a storage backend id when requesting the allocation of storage. If this parameter is not set, assume false. Service instances may either set one storage backend as default, or none - indicating that clients must always specify a storage backend.