Getting StartedAPI ReferenceRecipesGitHub
API Reference

Get the list of runs for a Protection Group.

get
https://cluster.ip.address/v2/data-protect/protection-groups//runs

Privileges: PROTECTION_VIEW

Get the runs for a particular Protection Group.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Specifies a unique id of the Protection Group.

Query Params
string

Specifies the protection run id.

int64

Start time for time range filter. Specify the start time as a Unix epoch Timestamp (in microseconds), only runs executing after this time will be returned. By default it is endTimeUsecs minus an hour.

int64

End time for time range filter. Specify the end time as a Unix epoch Timestamp (in microseconds), only runs executing before this time will be returned. By default it is current time.

tenantIds
array of strings

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

tenantIds
boolean

If true, the response will include Protection Group Runs which were created by all tenants which the current user has permission to see. If false, then only Protection Group Runs created by the current user will be returned.

runTypes
array of strings

Filter by run type. Only protection run matching the specified types will be returned.

boolean

Specifies if the result includes the object details for each protection run. If set to true, details of the protected object will be returned. If set to false or not specified, details will not be returned.

localBackupRunStatus
array of strings

Specifies a list of local backup status, runs matching the status will be returned.
'Running' indicates that the run is still running.
'Canceled' indicates that the run has been canceled.
'Canceling' indicates that the run is in the process of being canceled.
'Failed' indicates that the run has failed.
'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening.
'Succeeded' indicates that the run has finished successfully.
'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages.
'Paused' indicates that the ongoing run has been paused.
'Skipped' indicates that the run was skipped.

localBackupRunStatus
replicationRunStatus
array of strings

Specifies a list of replication status, runs matching the status will be returned.
'Running' indicates that the run is still running.
'Canceled' indicates that the run has been canceled.
'Canceling' indicates that the run is in the process of being canceled.
'Failed' indicates that the run has failed.
'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening.
'Succeeded' indicates that the run has finished successfully.
'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages.
'Paused' indicates that the ongoing run has been paused.
'Skipped' indicates that the run was skipped.

replicationRunStatus
archivalRunStatus
array of strings

Specifies a list of archival status, runs matching the status will be returned.
'Running' indicates that the run is still running.
'Canceled' indicates that the run has been canceled.
'Canceling' indicates that the run is in the process of being canceled.
'Failed' indicates that the run has failed.
'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening.
'Succeeded' indicates that the run has finished successfully.
'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages.
'Paused' indicates that the ongoing run has been paused.
'Skipped' indicates that the run was skipped.

archivalRunStatus
cloudSpinRunStatus
array of strings

Specifies a list of cloud spin status, runs matching the status will be returned.
'Running' indicates that the run is still running.
'Canceled' indicates that the run has been canceled.
'Canceling' indicates that the run is in the process of being canceled.
'Failed' indicates that the run has failed.
'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening.
'Succeeded' indicates that the run has finished successfully.
'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages.
'Paused' indicates that the ongoing run has been paused.
'Skipped' indicates that the run was skipped.

cloudSpinRunStatus
int64

Specifies the max number of runs. If not specified, at most 100 runs will be returned.

boolean
Defaults to false

Specifies whether to exclude non restorable runs. Run is treated restorable only if there is atleast one object snapshot (which may be either a local or an archival snapshot) which is not deleted or expired. Default value is false.

runTags
array of strings

Specifies a list of tags for protection runs. If this is specified, only the runs which match these tags will be returned.

runTags
boolean

Specifies whether we can serve the GET request from the read replica cache. There is a lag of 15 seconds between the read replica and primary data source.

boolean

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

snapshotTargetTypes
array of strings

Specifies the snapshot's target type which should be filtered. Note: this field is only considered when, filterByCopyTaskEndTime is set to true, or else it is ignored.

boolean

If set to false, all copy_tasks in any given valid state will be considered. If left empty or set to true, only successful copy_tasks would be considered. Note: this field is only considered when, filterByCopyTaskEndTime is set to true, or else it is ignored.

boolean

If true, then the details of the runs for which any copyTask completed in the given timerange will be returned. Only one of filterByEndTime and filterByCopyTaskEndTime can be set.

boolean

If set, magneto will truncate the response if it exceeds max size limit governed by magneto_http_rpc_response_size_limit_bytes

boolean

If set, returns only shell info such as run's start time, type, error if any.

boolean

Specifies whether to exclude runs with error. If no value is specified, then runs with errors are included.

int64

Return a specific Job Run by specifying a time and a group id. 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.

boolean

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

boolean

Specifies if needs to include proto extensions if they are extended.

boolean

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

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.

int64

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

string

Specifies the cookie to fetch the next page of results

boolean

If true, then the response will include all target runs information for the protection run. If false or not specified, only the latest copy (target) run information will be returned.

Headers
string
enum

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

Allowed:
Responses

Updated 3 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago