Search server snapshots

get

https://{host}/platform/admindata/v1/snapshots

Returns a list of server snapshots.

A server snapshot is a read-only, static version of a data server. Intelligent Risk Platform automatically takes periodic snapshots of Intelligent Risk Platform managed server instances.

This operation supports response filtering based the value of a subset of properties. Depending on the property, you may use a combination of comparison operators, list operators, and logical operators. For details, see Filtering Responses.

🪰
Entitlements
RI-DATAVAULT

Query Params

filter

string

Query string to select response data based on property values.

Property	Comparison	List
`createdAt`	`=`, `!=`, `>`, `<`, `>=`, `<=`
`databaseCount`	`=`, `!=`, `>`, `<`, `>=`, `<=`	`IN`, `NOT IN`
`expiresAt`	`=`, `!=`, `>`, `<`, `>=`, `<=`
`isCopiedToArchive`	`=`, `!=`
`serverType`	`=`, `!=`, `LIKE`, `NOT LIKE`	`IN`, `NOT IN`
`sizeInMb`	`=`, `!=`, `>`, `<`, `>=`, `<=`	`IN`, `NOT IN`
`snapshotId`	`=`, `!=`, `>`, `<`, `>=`, `<=`	`IN`, `NOT IN`

To learn more, see Filtering Responses.

sort

string

Defaults to createdAt DESC

Property to sort by, followed by one of ASC (ascending) or DESC (descending).

limit

int32

1 to 1000

Defaults to 100

Number of records to display per page.

offset

int32

≥ 0

Defaults to 0

Number of the page displaying the returned records, starting at 0.

Responses

Entitlements

200Success

400Bad Request. An invalid sort or order value was supplied.

401Unauthorized

403Forbidden. The client does not have the required RI-DATAVAULT entitlement, or the user does not have permission to view snapshots.

500Internal Server Error