Listing, Sorting and Filtering Storage Instances
This endpoint returns the list of storage instances in the specified project.
Sorting
The results from this endpoint can be ordered using the $orderby
query parameter. Specify a field name, and optionally asc
or desc
.
Sorting is valid on the following fields: id
, name
, type
, cloud/name
, cloud/region/name
, privateLinkServiceConnectionStatus
Filtering
There are two ways to filter the set of returned storage instances from this endpoint - the first is to use the $filter
query parameter, the second is to use the
$label_key
and $label
query parameters.
$filter
allows for storage instances to be filtered on the basis of fields in the schema using OData query syntax.
See this document for more details on the syntax used.
Filters are valid on the following fields: id
, name
, type
, cloud/name
, cloud/region/name
, privateLinkServiceConnectionStatus
Examples:
?$top=10
- Returns only the first 10 storage instances from the list.
?$orderby=name desc
- Sorts storage instances by name in descending order.
?$filter=name eq 'descriptive name'
- Returns storage instances that match the provided name.
?$orderby=properties/created desc
- Sorts storage instances by creation date in descending order.
?$filter=properties/created ge 2021-01-01T00:00:00Z
- Returns storage instances created after January 1, 2021.