Getting StartedAPI ReferenceRecipesGitHub
API Reference

List the Restore Tasks filtered by the specified parameters.

get
https://cluster.ip.address/irisservices/api/v1/public/restore/tasks

Privileges: RESTORE_VIEW

If no parameters are specified, all Restore Tasks found
on the Cohesity Cluster are returned. Both running and completed
Restore Tasks are reported.
Specifying parameters filters the results that are returned.

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

Filter by a list of Restore Task ids.

taskIds
int64

Filter by a start time specified as a Unix epoch Timestamp
(in microseconds). All Restore Tasks (both completed and running)
on the Cohesity Cluster that started after the specified start time
but before the specified end time are returned.
If not set, the start time is creation time of the Cohesity Cluster.

int64

Filter by an end time specified as a Unix epoch Timestamp
(in microseconds). All Restore Tasks (both completed and running)
on the Cohesity Cluster that started after the specified start time
but before the specified end time are returned.
If not set, the end time is the current time.

int64

Specifies the number of completed Restore Tasks to return in the response
for pagination purposes. Running Restore Tasks are always returned.
The newest completed Restore Tasks are returned.

taskTypes
array of strings

Filter by the types of Restore Tasks such as 'kRecoverVMs',
'kCloneVMs', 'kCloneView' or 'kMountVolumes'.

taskTypes
string
enum

Specifies the environment like VMware, SQL, where the
Protection Source exists.
Supported environment types such as 'kView', 'kSQL', 'kVMware', etc.
NOTE: 'kPuppeteer' refers to Cohesity's Remote Adapter.
'kVMware' indicates the VMware Protection Source environment.
'kHyperV' indicates the HyperV Protection Source environment.
'kSQL' indicates the SQL Protection Source environment.
'kView' indicates the View Protection Source environment.
'kPuppeteer' indicates the Cohesity's Remote Adapter.
'kPhysical' indicates the physical Protection Source environment.
'kPure' indicates the Pure Storage Protection Source environment.
'kNimble' indicates the Nimble Storage Protection Source environment.
'kHpe3Par' indicates the Hpe 3Par Storage Protection Source environment.
'kAzure' indicates the Microsoft's Azure Protection Source environment.
'kNetapp' indicates the Netapp Protection Source environment.
'kAgent' indicates the Agent Protection Source environment.
'kGenericNas' indicates the Generic Network Attached Storage Protection
Source environment.
'kAcropolis' indicates the Acropolis Protection Source environment.
'kPhysicalFiles' indicates the Physical Files Protection Source environment.
'kIbmFlashSystem' indicates the IBM Flash System Protection Source environment.
'kIsilon' indicates the Dell EMC's Isilon Protection Source environment.
'kGPFS' indicates IBM's GPFS Protection Source environment.
'kKVM' indicates the KVM Protection Source environment.
'kAWS' indicates the AWS Protection Source environment.
'kExchange' indicates the Exchange Protection Source environment.
'kHyperVVSS' indicates the HyperV VSS Protection Source
environment.
'kOracle' indicates the Oracle Protection Source environment.
'kGCP' indicates the Google Cloud Platform Protection Source environment.
'kFlashBlade' indicates the Flash Blade Protection Source environment.
'kAWSNative' indicates the AWS Native Protection Source environment.
'kO365' indicates the Office 365 Protection Source environment.
'kO365Outlook' indicates Office 365 outlook Protection Source environment.
'kHyperFlex' indicates the Hyper Flex Protection Source environment.
'kGCPNative' indicates the GCP Native Protection Source environment.
'kAzureNative' indicates the Azure Native Protection Source environment.
'kKubernetes' indicates a Kubernetes Protection Source environment.
'kElastifile' indicates Elastifile Protection Source environment.
'kAD' indicates Active Directory Protection Source environment.
'kRDSSnapshotManager' indicates AWS RDS Protection Source environment.
'kCassandra' indicates Cassandra Protection Source environment.
'kMongoDB' indicates MongoDB Protection Source environment.
'kCouchbase' indicates Couchbase Protection Source environment.
'kHdfs' indicates Hdfs Protection Source environment.
'kHive' indicates Hive Protection Source environment.
'kHBase' indicates HBase Protection Source environment.
'kUDA' indicates Universal Data Adapter Protection Source environment.
'kSAPHANA' indicates SAP HANA protection source environment.
'kDB2' indicates DB2 Protection Source environment.
'kO365Teams' indicates the Office365 Teams Protection Source environment.
'kO365Group' indicates the Office365 Groups Protection Source environment.
'kO365Exchange' indicates the Office365 Mailbox Protection Source environment.
'kO365OneDrive' indicates the Office365 OneDrive Protection Source environment.
'kO365Sharepoint' indicates the Office365 SharePoint Protection Source environment.
'kO365PublicFolders' indicates the Office365 PublicFolders Protection Source environment.
'kPostgres' indicates the Postgres Protection Source environment.
kHpe3Par, kIbmFlashSystem, kAzure, kNetapp, kAgent, kGenericNas, kAcropolis,
kPhysicalFiles, kIsilon, kGPFS, kKVM, kAWS, kExchange, kHyperVVSS, kOracle,
kGCP, kFlashBlade, kAWSNative, kO365, kO365Outlook, kHyperFlex, kGCPNative,
kAzureNative, kKubernetes, kElastifile, kAD, kRDSSnapshotManager,
kCassandra, kMongoDB, kCouchbase, kHdfs, kHive, kHBase, kUDA, kSAPHANA,
kO365Teams, kO365Group, kO365Exchange, kO365OneDrive, kO365Sharepoint,
kO365PublicFolders, kMongoDBPhysical, kPostgres

storageDomainIds
array of int64s

Filter by a list of Storage Domain IDs. This field applies only if
'TaskTypes' includes 'kCloneView'. Only task writing data to these storage
domains will be returned.

storageDomainIds
Responses

Updated about 5 hours ago

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

Updated about 5 hours ago

Did this page help you?