Get protection details about the specified list of leaf Protection Source Objects (such as a VMs).

get

https://cluster.ip.address/irisservices/api/v1/public/reports/protectionSourcesJobRuns

Privileges: REPORTS_VIEW, TENANT_VIEW

Returns the Snapshots that contain backups of the specified
Protection Source Objects and match the specified filter criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

tenantIds

array of strings

TenantIds contains ids of the tenants for which objects are to be
returned.

tenantIds

allUnderHierarchy

boolean

AllUnderHierarchy specifies if objects of all the tenants under the
hierarchy of the logged in user's organization should be returned.

jobIds

array of int64s

Filter by a list of Job ids. Snapshots for the specified
Protection Jobs are listed.

jobIds

startTimeUsecs

int64

Filter by a start time. Snapshots that started after the
specified time are returned.
Specify the start time as a Unix epoch Timestamp (in microseconds).

endTimeUsecs

int64

Filter by a end time. Snapshots that ended before the
specified time are returned.
Specify the end time as a Unix epoch Timestamp (in microseconds).

environments

array of strings

Filter by a list of environment types such as 'kVMware', 'kView', etc.
NOTE: 'kPuppeteer' refers to Cohesity's Remote Adapter.

environments

protectionSourceIds

array of int64s

required

Filter by a list of leaf Protection Sources Objects (such as VMs).
Snapshots of the specified Protection Source Objects are returned.

protectionSourceIds*

outputFormat

string

Specifies the format for the output such as 'cvs' or 'json'.
If not specified, the json format is returned.
If 'csv' is specified, a comma-separated list with a heading
row is returned.

pageCount

int32

Specifies the number of Snapshots to return in the response for
pagination purposes. Used in combination with the paginationCookie in
the response to return multiple sets of Snapshots.

runStatus

array of strings

Filter by a list of run statuses such as 'kRunning',
'kSuccess', 'kFailure' etc.
Snapshots of Job Runs with the specified run statuses are reported.
'kSuccess' indicates that the Job Run was successful.
'kRunning' indicates that the Job Run is currently running.
'kWarning' indicates that the Job Run was successful but warnings were
issued.
'kCancelled' indicates that the Job Run was canceled.
'kError' indicates the Job Run encountered an error and did not run to
completion.

runStatus

Allowed:

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