List Protection Policy Summary.

get

https://cluster.ip.address/irisservices/api/v1/public/protectionPolicySummary

Privileges: PROTECTION_POLICY_VIEW

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

required

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

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
end time are included int he 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.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Success

defaultError