List Protections Jobs filtered by the specified parameters.

get

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

Privileges: PROTECTION_VIEW

If no parameters are specified, all Protection Jobs currently
on the Cohesity Cluster are returned.
Specifying parameters filters the results that are returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids

array of int64s

Filter by a list of Protection Job ids.

ids

names

array of strings

Filter by a list of Protection Job names.

names

policyIds

array of strings

Filter by Policy ids that are associated with Protection Jobs.
Only Jobs associated with the specified Policy ids, are returned.

policyIds

environments

array of strings

Filter by environment types such as 'kVMware', 'kView', etc.
Only Jobs protecting the specified environment types are returned.
NOTE: 'kPuppeteer' refers to Cohesity's Remote Adapter.

environments

isActive

boolean

Filter by Inactive or Active Jobs. If not set, all Inactive and
Active Jobs are returned. If true, only Active Jobs are returned.
If false, only Inactive Jobs are returned.
When you create a Protection Job on a Primary Cluster
with a replication schedule, the Cluster creates an
Inactive copy of the Job on the Remote Cluster.
In addition, when an Active and running Job is deactivated,
the Job becomes Inactive.

isDeleted

boolean

If true, return only Protection Jobs that have been deleted but still
have Snapshots associated with them.
If false, return all Protection Jobs except those Jobs that have
been deleted and still have Snapshots associated with them.
A Job that is deleted with all its Snapshots is not returned for
either of these cases.

onlyReturnBasicSummary

boolean

if true then only job descriptions and the most recent run of the job
will be returned.

includeLastRunAndStats

boolean

If true, return the last Protection Run of the Job and the summary stats.

includeRpoSnapshots

boolean

If true, then the Protected Objects protected by RPO policies will also
be returned.

isLastRunSlaViolated

boolean

IsLastRunSlaViolated is the parameter to filter the Protection Jobs based
on the SLA violation status of the last Protection Run.

onlyReturnDataMigrationJobs

boolean

OnlyReturnDataMigrationJobs specifies if only data migration jobs should be
returned. If not set, no data migration job will be returned.

pruneExcludedSourceIds

boolean

If true, the list of exclusion sources will be omitted from the response.
This can be used to improve performance when the exclusion sources are
not needed.

includeSourceNames

boolean

If true, both names and ids of Sources inside the protection group will be
sent in the response.
If false, only Source ids will be sent in the response.

maxResultCount

int64

Identifies the max number of items to be returned. This is specifically
to be used with pagination.

paginationCookie

string

Pagination cookie to fetch the next set of results.

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.

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