Get the protection policy summary

get

https://cluster.ip.address/v2/data-protect/policies/{id}/summary

Privileges: PROTECTION_POLICY_VIEW

Fetch the summary for a given protection policy.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Specifies the id of the policy whose summary should be retrieved. If this is not set, the API will return error.

Query Params

includeAggregatedLastRunSummary

boolean

Specifies whether to include summary of the last Protection Run of each Protection Source

includeAggregatedRunsSummary

boolean

Specifies whether to include summary of all Protection Runs of the Protection Source or Protection Jobs. If this is set to true, then only the Protection Runs from the provided 'startTimeUsecs' and 'endTimeUsecs' are processed.

startTimeUsecs

int64

Filter by a start time specified as a Unix epoch Timestamp (in microseconds). Only Job Runs that started after the specified time are included in the aggregated runs summary result.

endTimeUsecs

int64

Filter by a end time specified as a Unix epoch Timestamp (in microseconds). Only Job Runs that completed before the specified time are included in the aggregated runs summary result.

pageCount

int64

Specifies the limit of the number of Protection Sources or Protection Jobs to be returned as a part of the Protection Policy Summary.

paginationCookie

string

If set, i.e. there are more results to display, use this value to get the next set of results, by using this value in paginationCookie param for the next request to GetProtectionPolicySummary.

Headers

requestInitiatorType

string

enum

Specifies the type of request from UI, which is used for services like magneto to determine the priority of requests.

Allowed:

Responses

200Success

defaultError