List the snapshots for a given object.

get

https://cluster.ip.address/v2/data-protect/objects/{id}/snapshots

Privileges: RESTORE_VIEW

List the snapshots for a given object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Specifies the id of the Object.

Query Params

fromTimeUsecs

int64

Specifies the timestamp in Unix time epoch in microseconds to filter Object's snapshots which were taken after this value.

toTimeUsecs

int64

Specifies the timestamp in Unix time epoch in microseconds to filter Object's snapshots which were taken before this value.

runStartFromTimeUsecs

int64

Specifies the timestamp in Unix time epoch in microseconds to filter Object's snapshots which were run after this value.

runStartToTimeUsecs

int64

Specifies the timestamp in Unix time epoch in microseconds to filter Object's snapshots which were run before this value.

snapshotActions

array of strings, unique

Specifies a list of recovery actions. Only snapshots that applies to these actions will be returned.

runTypes

array of strings, unique

Filter by run type. Only protection run matching the specified types will be returned. By default, CDP hydration snapshots are not included, unless explicitly queried using this field.

protectionGroupIds

array of strings

If specified, this returns only the snapshots of the specified object ID, which belong to the provided protection group IDs.

protectionGroupIds

runInstanceIds

array of int64s

Filter by a list run instance ids. If specified, only snapshots created by these protection runs will be returned.

runInstanceIds

regionIds

array of strings

Filter by a list of region ids.

regionIds

objectActionKeys

array of strings

Filter by ObjectActionKey, which uniquely represents protection of an object. An object can be protected in multiple ways but atmost once for a given combination of ObjectActionKey. When specified, only snapshots matching given action keys are returned for corresponding object.

objectActionKeys

fetchFastRestorePointsOnly

boolean

Specifies whether to fetch only fast restore points. This is applicable only for M365 CSM Restore.

emailSubjects

array of strings

length ≤ 3

Specifies one or more email subjects to search for in a granular Exchange search against Microsoft Backup Storage. Up to 3 values may be supplied; multiple values are combined with logical AND per Microsoft Graph granular search rules. Repeat the query parameter for each value (e.g. emailSubjects=Hedp,Test).

emailSubjects

senderAddress

string

Specifies the sender email address to search for in a granular Exchange search against Microsoft Backup Storage.

recipientAddresses

array of strings

length ≤ 3

Specifies the recipient email addresses (any of To, Cc, Bcc) to search for in a granular Exchange search against Microsoft Backup Storage. Up to 3 values may be supplied; multiple values are combined with logical AND per Microsoft Graph granular search rules. Repeat the query parameter for each value.

recipientAddresses

hasAttachment

boolean

Specifies whether to filter by emails with attachments in a granular Exchange search against Microsoft Backup Storage.

emailTypes

array of strings

length ≤ 1

Specifies the email item types to search for in a granular Exchange search against Microsoft Backup Storage (e.g. Email, Calendar, Contact, Task). At most one value may be supplied; mapped to Microsoft Graph MessageKind -eq.

emailTypes

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError