List Protection Job Runs filtered by the specified parameters.

get

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

If no parameters are specified, Job Runs currently
on the Cohesity Cluster are returned. Both running and completed Job Runs
are reported.
Specifying parameters filters the results that are returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

jobId

int64

Filter by a Protection Job that is specified by id.
If not specified, all Job Runs for all Protection Jobs are returned.

includeRpoSnapshots

boolean

If true, then the snapshots for Protection Sources protected by Rpo
policies will also be returned.

startedTimeUsecs

int64

Return a specific Job Run by specifying a time and a jobId.
Specify the time when the Job Run started as a
Unix epoch Timestamp (in microseconds).
If this field is specified, jobId must also be
specified.

startTimeUsecs

int64

Filter by a start time. Only Job Runs 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 specified as a Unix epoch Timestamp
(in microseconds). Only Job Runs that completed before the specified
end time are returned.

numRuns

int64

Specify the number of Job Runs to return.
The newest Job Runs are returned.

excludeTasks

boolean

If true, the individual backup status for all the objects protected by
the Job Run are not populated in the response. For example in a VMware
environment, the status of backing up each VM associated with a Job
is not returned.

sourceId

int64

Filter by source id. Only Job Runs protecting the specified source
(such as a VM or View) are returned. The source id
is assigned by the Cohesity Cluster.

runTypes

array of strings

Filter by run type such as 'kFull', 'kRegular' or 'kLog'.
If not specified, Job Runs of all types are returned.

runTypes

excludeErrorRuns

boolean

Filter out Jobs Runs with errors by setting this field to 'true'.
If not set or set to 'false', Job Runs with errors are returned.

excludeNonRestoreableRuns

boolean

Filter out jobs runs that cannot be restored by setting this field to
'true'. If not set or set to 'false', Runs without any successful
object will be returned. The default value is false.

onlyReturnShellInfo

boolean

If passed as true, then only returns the summary information about run
including details such as runs start time, status, type etc. It does not
include extra details such as attempt/task info etc.

filterByEndTime

boolean

If true, the runs with end time within the specified time range will be
returned. Otherwise, the runs with start time in the time range are
returned.

filterByCopyTaskEndTime

boolean

If true, then the details of the backup runs along with CopyRuns will be
returned where those backup run has atleast one CopyTask that is completed
in the given Time Range. If this field is true, then other filters such as
filterByEndTime should not be applied.

copyRunTypes

array of strings

Following field contains a list of valid CopyTarget i.e Replication,
Archival representing the types of copy runs needed to be looked at
the given time window, denoted via TimeRange. When left empty both
Replication and Archival are considered.
This input is only considered valid when
filterByCopyTaskEndTime is set to true. Else it is ignored.
Independently of this list, the local copy run is additionally returned
when showImmutabilityParam is true or durationUnit is set, since the
backup objects' and backup run's immutability is derived from the local
copy's datalock and their retention/expiry from its snapshot expiry.

copyRunTypes

onlyIncludeSuccessfulCopyRuns

boolean

If marked false, all CopyTasks in any finished state like cancelled,
failed in the given time window will be considered. Otherwise if kept
empty or marked as true, only the copy_tasks with kSuccess status will
be considered. This input is only considered valid when
filterByCopyTaskEndTime is set to true. Else it is ignored.

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.

humanReadableTime

boolean

If set to true, the response will additionally populate the
'startTimeHhmm' / 'endTimeHhmm' (and related *Hhmm) fields on each
backup-run, copy-run runStartTimeHhmm, per-source backup status,
copy-task start/end timestamps, copy run stats (start/end only), or
shell-info entry start/end pairs. Copy-run expiry has no sibling *Hhmm
field; use expiryTimeUsecs. Each value is the zero-padded 24-hour
wall-clock time-of-day ("HH:MM") of the corresponding *Usecs epoch field,
rendered in the owning Protection Group's configured timezone (NOT UTC).
The timezone used is reported once per run in the run-level 'timezone'
field. The existing epoch fields are not modified and remain the source
of truth (always UTC).
Default: false (response shape unchanged).

showImmutabilityParam

boolean

If true, includes the immutability field in the protection runs
response. Default is false.
When combined with filterByCopyTaskEndTime, the local copy run is kept
in the response in addition to the copy targets selected by
copyRunTypes, because it carries the datalock the backup objects' and
backup run's immutability is derived from.

objectLevelBackupFrequencyUnit

string

enum

When set, the response additionally populates 'backupFrequency' on
each SourceBackupStatus entry inside BackupRun. The value is a
DurationInUnit expressed in the specified unit, derived from the magneto
backup_frequency_usecs field on each object's backup task. Omitted per
entry when the underlying frequency is not available.
Default: omitted (backupFrequency fields absent).
DurationUnit specifies the time unit a Duration value is expressed in.
Used by APIs that report or accept a derived integer duration alongside
its unit, including schedule frequencies and retention durations on
protection-policy and protection-run responses (and by the matching
'durationUnit' query parameter that selects the unit those responses
should be expressed in).

Allowed:

objectLevelReplicationFrequencyUnit

string

enum

When set, the response additionally populates 'replicationFrequency' on
each SourceBackupStatus entry inside BackupRun. The value is a
DurationInUnit expressed in the specified unit, derived from the magneto
replication_frequency_usecs field on each object's backup task. Omitted
per entry when the underlying frequency is not available.
Default: omitted (replicationFrequency fields absent).
DurationUnit specifies the time unit a Duration value is expressed in.
Used by APIs that report or accept a derived integer duration alongside
its unit, including schedule frequencies and retention durations on
protection-policy and protection-run responses (and by the matching
'durationUnit' query parameter that selects the unit those responses
should be expressed in).

Allowed:

durationUnit

string

enum

Specifies the time unit in which schedule frequencies and retention
durations should be expressed in the response. When supplied, the
server rewrites every applicable duration field so it expresses the
same interval in the requested unit. The /public/protectionRuns
endpoint does not return schedule fields, so on this endpoint the
parameter only controls how the additive 'retentionPeriod'
(DurationInUnit) sibling fields are populated on BackupRun
(primary/local snapshot) and on each CopyRun entry (replication,
archival, etc.):
For each CopyRun with expiryTimeUsecs populated, retentionPeriod
is the floor of the (expiryTimeUsecs - backup-run anchor) gap
expressed in the requested unit. The anchor is
backupRun.stats.endTimeUsecs when > 0, otherwise
backupRun.stats.startTimeUsecs.
BackupRun.retentionPeriod mirrors the first kLocal CopyRun value
(primary backup retention clock).
The existing expiryTimeUsecs / *Usecs epoch fields are not modified
and remain the source of truth. retentionPeriod is omitted per entry
when derivation is not possible.
When combined with filterByCopyTaskEndTime, the local copy run is kept
in the response in addition to the copy targets selected by copyRunTypes,
because the backup run and its objects derive their retention and expiry
from the local copy's snapshot expiry.
Default: omitted (retentionPeriod fields absent).
DurationUnit specifies the time unit a Duration value is expressed in.
Used by APIs that report or accept a derived integer duration alongside
its unit, including schedule frequencies and retention durations on
protection-policy and protection-run responses (and by the matching
'durationUnit' query parameter that selects the unit those responses
should be expressed in).

Allowed:

Responses

200Success

defaultError