Get information about all datastore snapshots.

get/backup-recovery/v1beta1/datastores/{id}/snapshots

Get information about all datastore snapshots.

Securitybearer
Request
path Parameters
id
required
string

UUID string uniquely identifying the datastore

Example: 9b4c14a6-3cd5-4907-97c4-cf44c5b641e4
query Parameters
offset
integer

The number of items to omit from the beginning of the result set. The offset and limit query parameters are used in conjunction with pagination. For example "offset=30&limit=10" indicates the fourth page of 10 items.

limit
integer [ 1 .. 1000 ]
Default: 20

The maximum number of items to include in the response. The offset and limit query parameters are used in conjunction with pagination. For example "offset=30&limit=10" indicates the fourth page of 10 items.

filter
string

An expression that enables you to filter the results.

A comparison compares a property name to a literal. The following comparisons are supported:

  • “eq” : Is a property equal to value. Valid for number, boolean and string properties.
  • “gt” : Is a property greater than a value. Valid for number or string timestamp properties.
  • “lt” : Is a property less than a value. Valid for number or string timestamp properties.
  • “in” : Is a value in a property (that is an array of strings).

Filters are supported on the following attributes:

  • snapshotType
  • state
  • status
  • createdByInfo/id
  • createdByInfo/name
  • storageSystemsInfo/id
  • storageSystemsInfo/storageSystemType
  • storageSystemsInfo/name
  • consistency
  • pointInTime
  • dataOrchestratorInfo/id
  • expiresAt
  • name
sort
string

Comma separated list of properties defining the sort order. Each item in the “sort” query parameter is a property name optionally followed by a direction indicator. The direction indicator may only be either “asc” (ascending) or “desc” (descending). If no direction indicator is specified, the default order is ascending.

select
string

The select query parameter is used to limit the properties returned with a resource or collection-level GET. Multiple properties can be listed to be returned. The server must only return the set of properties requested by the client formatted as an exclusive comma separated list of properties. If not specified, all properties are returned.

Responses
200

datastore snapshots list

400

Bad/Malformed request

401

Unauthorized request

403

Forbidden

404

The filter attribute's value does not exist

500

Internal Server ErrorResponse.

Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "items": [
    ],
  • "offset": 0,
  • "total": 0
}