Getting StartedAPI ReferenceRecipesGitHub
API Reference

Lists the Recoveries.

get
https://helios.cohesity.com/v2/data-protect/recoveries

Lists the Recoveries.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids
array of strings

Filter Recoveries for given ids.

ids
boolean

Returns only child recoveries if passed as true. This filter should always be used along with 'ids' filter.

tenantIds
array of strings

TenantIds contains ids of the organizations for which recoveries are to be returned.

tenantIds
boolean

Specifies if objects of all the organizations under the hierarchy of the logged in user's organization should be returned.

int64

Returns the recoveries which are started after the specific time. This value should be in Unix timestamp epoch in microseconds.

int64

Returns the recoveries which are started before the specific time. This value should be in Unix timestamp epoch in microseconds.

int64

Filter by Storage Domain id. Only recoveries writing data to this Storage Domain will be returned.

snapshotTargetType
array of strings

Specifies the snapshot's target type from which recovery has been performed.

archivalTargetType
array of strings

Specifies the snapshot's archival target type from which recovery has been performed. This parameter applies only if 'snapshotTargetType' is 'Archival'.

snapshotEnvironments
array of strings

Specifies the list of snapshot environment types to filter Recoveries. If empty, Recoveries related to all environments will be returned.

status
array of strings

Specifies the list of run status to filter Recoveries. If empty, Recoveries with all run status will be returned.

recoveryActions
array of strings

Specifies the list of recovery actions to filter Recoveries. If empty, Recoveries related to all actions will be returned.

recoveryActions
boolean
Defaults to false

If set to true, also allows child tasks created by restore jobs or multi-state restores to be returned.

boolean
Defaults to false

Return only recoveries initiated from the snapshots in FortKnox Onprem vaults if it set to true. Otherwise, return all recoveries as default.

boolean
Defaults to false

Specifies if objects should be excluded from the response.

Headers
int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

Updated 4 months ago

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

Updated 4 months ago