v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB

File Server

List all snapshots

Returns snapshots for the specified backup set.

get/fileserver/v2/orgs/{orgID}/backupsets/{backupsetID}/snapshots

Path parameters

orgIDinteger required

Specify the ID of your organization. Get the ID of an organization using the 'List all organizations' API.

backupsetIDinteger required

Specify the ID of your backup set. Get the ID using the 'List backup sets' API.

Query parameters

snapshotTypes'HOT' | 'WARM' | 'COLD'

Specify the type of snapshot. The possible values for the snapshot type are: "HOT", "WARM", and "COLD". Specify multiple snapshot types by separating the values with commas.

fromTimestring date-time

Specify a date and time in the UTC format YYYY-MM-DDTHH:MM:SSZ to display all snapshots created after this date and time.

toTimestring date-time

Specify a date and time in the UTC format YYYY-MM-DDTHH:MM:SSZ to display all snapshots created before this date and time.

sortOrderstring

Specify whether to sort the returned snapshots in ascending or descending order of the snapshot creation time. Set it to "ASC" or "DESC" to sort the list in ascending or descending order respectively. The default value is ASC.

pageTokenstring

Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.

Response

Success

nextPageTokenstring

The token to access the next page of results. This parameter will be empty for the last page of results.