Get the list of runs for an object.

get

https://cluster.ip.address/v2/data-protect/objects/{id}/runs

Privileges: PROTECTION_VIEW

Get the runs for a particular object.

Path Params

int64

required

Specifies a unique id of the object.

Query Params

runId

string

Specifies a unique id of the run.

startTimeUsecs

int64

Filter by a start time when the run starts. Specify the start time as a Unix epoch Timestamp (in microseconds).

endTimeUsecs

int64

Filter by a end time when the run starts. Specify the start time as a Unix epoch Timestamp (in microseconds).

tenantIds

array of strings

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

tenantIds

includeTenants

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.

localBackupObjectStatus

array of strings

Specifies a list of status for the object in the backup run.

localBackupObjectStatus

replicationObjectStatus

array of strings

Specifies a list of status for the object in the replication run.

replicationObjectStatus

archivalObjectStatus

array of strings

Specifies a list of status for the object in the archival run.

archivalObjectStatus

cloudSpinRunStatus

array of strings

Specifies a list of status for the object in the cloud spin run.

cloudSpinRunStatus

numRuns

int64

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

paginationCookie

string

Specifies the pagination cookie with which subsequent parts of the response can be fetched. Users can use this to get next runs

excludeNonRestorableRuns

boolean

Defaults to false

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

Responses

200Success

defaultError