Sign in
Service

Storage Backend Information

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

Storage Backends are sorted in alphabetical order of their label by default. For resources where label is unset, id shall be used. Resources using this fallback shall be sorted after those that aren't by default, and before when reverse_order is true.

get/service/storage-backends

Query parameters

tag.{name}string

A list of tag values, formatted for use in query string parameters

Filter on Storage Backends that have a tag named {name} with a value in the given comma-seperated list of values. The {name} and the value MUST be URL encoded where special characters are present. Where the tag's value is a string, at least one of the given values will match. Where the tag's value is an array, at least one value in the array will match at least one of the given values. Partial string matches of the values are not valid.

tag_exists.{name}boolean

Filter on Storage Backends that have a tag named {name} regardless of value. The {name} MUST be URL encoded where special characters are present. If set to true then the presence of the tag is filtered for. If set to false then its absence is. If left out then no filtering on tag presence is performed.

reverse_orderboolean

Return Storage Backends in reverse-alphabetical order of their label.

pagestring

Opaque string used by backend to access a specific page of results. Clients should read the next URL from the Link header returned with responses, or use value of the returned X-Paging-NextKey header. If not supplied, the first page is accessed. Service implementations should ensure a consistent sort order is applied to pages of results.

limitinteger

Restrict the response to the specified number of results. Service implementations may specify their own default and maximum for the limit

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.

tagsTags

Key is a freeform string. Value is a freeform string, or an array of freeform strings.

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.

Changes