AccessToken
- Create a new API access tokenpost
ActiveDirectory
Alert
AntivirusService
User
AthenaAppOps
- Relaunch app instanceput
- Relaunch System Appput
App
AuditLog
CohesityCA
Platform
Security
Tenant
Config
- Get SNMP configuration.get
DataAccessor
Agent
CloudDomain
- /data-protect/attach-cloud-domainpost
ExternalTarget
Failover
Object
ProtectionGroup
Policy
ProtectedObject
Recovery
RecoveryScan
CloudRetrieveTask
Search
Source
Templates
- Download the azure resource template.get
DataSourceConnection
DataSourceConnectorLocal
DataSourceConnector
DataTiering
MFA
FortknoxOnprem
View
health
- Get Health Statusget
HeliosOnPrem
- Retreive Helios OnPrem Configurationget
- Update Helios OnPrem Configurationput
OneHelios
Registration
- Register to Helios.post
- Lists the Helios Registration Config.get
KerberosProvider
IdentityProvider
Keystone
KeyManagementSystem
LDAP
LSU
HeliosNotifications
- Get helios notificationsget
ClusterRegistration
ClusterManagement
CopyStats
- Get copy details.post
Snapshots
- Trigger snapshot discovery actions.post
HeliosDataProtectStats
- Data-Protect Usage Statisticsget
- RPaaS Usage Statisticsget
DSPM
- Get DSPM runs.get
- Perform actions for a DSPM schedule.post
Rpaas
Fortknox
HeliosIdentityProvider
HeliosPrincipals
ProviderInstances
- List Provider Instancesget
Stats
SecurityIntegration
SessionManagement
- Fetch Session Management Configget
- Save Session Management Configput
Certificate
- Get the Helios SSL Certificate.get
TaggingService
Firewall
Routes
NodeGroup
Privilege
- Get Privileges.get
RemoteClusters
RemoteStorage
Role
CertificateStore
Support
SnmpConfig
- Get Snmp Configget
- Update Snmp Configput
Syslog
StorageDomain
HeliosTagging
TenantDeactivation
- /tenants/deactivationspost
- /tenants/{id}/deactivationpost
Tag
Platform
Certificates
- Get the Server Certificate configured on the Cluster.get
Stats
User
Platform
Encryption
- Get the encryption summary of the connected onprem clusters and viewboxes within the clusters for a given helios user.get
ConnectorAgent
HeliosMultiTenancy
- Tenant Actions.post
OAuth2

Datasets
LLMs
Conversations
QueryFeedback
- Provide feedback on a query responsepost
Documents
- Get the document details.get
- Search for similar document parts matching the input query.post
AccountConfig
ConversationBot
- The cohesity Conversation AI bot.post
GaiaAiEngineConnections
AuthDirectories
GaiaUsageStats
- Gaia Usage stats for a given accountIDget
SupportedRegions
- Get supported regionsget
Files
ExhaustiveSearchDownload
Objects
- Get the objects.get
SensitiveDataHandling
- Retrieve sensitive data policiesget

Streams
HeliosTagging

Fortknox

Sites
Applications
DRPlan
Reports
- Export a report.post
HealthChecks
- Initiate health check.post
Objects
- Initiate asynchronous operations.post
- Get an operation by ID.get
Stats
- Get detailed statistics.post

Artifacts
- Fetch report artifact for taskget
Components
Filters
- Get resourcespost
Reports
Schedules
Tasks
- Fetch Tasksget
- Fetch a Taskget

AccessToken
- Create a new API access tokenpost
Alert
- Get alerts summary.get
BaseosPatchManagement
MFA
User
PatchManagement
Platform
OneHelios
Stats
- Get Time Series Stats.get
Support
Syslog

Backup
Restore
- Trigger a restore run.post

Cluster/Helios
- List details about the Cohesity Cluster/Helios such as the name, type, version, language, locale and domains. This operation does not require authentication.get
- List feature flags and their current boolean status for this Cohesity Cluster/Helios. This operation does not require authentication.get

License
HeliosSelfManagedSpecific
- Download audit reports for on-prem licensingget
- Import Entitlementspost

ApplicationGroups
IacScans
- The Application Group IaC Scan Post API initiates a discovery operation for an Application Group.post
- The Application Group IaC Scan Get API retrieves discovery information for an Application Group.get

rigelmgmt

Get the status of all the past and current failover for the specified Backup and Recovery instance. Here the Backup and Recovery instance refers to the vault.

get

https://helios.cohesity.com/v2/data-protect/failovers/{vaultId}

Gets the status of all the past and current failover of all Protection
Groups and Policies for the specified Backup and Recovery instance i.e
vault.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

vaultId

int64

required

Specifies the unique id of the Backup and Recovery instance i.e. vault for which the failover status is to be fetched.

Query Params

cloudType

string

enum

required

Specifies the cloud environment type where the Backup and Recovery instance is used. Currently, only 'ibm' is supported for failovers.

Allowed:

Headers

accessClusterId

int64

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

Responses

Updated 2 months ago

Initiate a failover for the specified Backup and Recovery instance. Here the Backup and Recovery instance refers to the vault.

Initiate an action e.g. cancel the in-progress failover

Did this page help you?

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 2 months ago

Initiate a failover for the specified Backup and Recovery instance. Here the Backup and Recovery instance refers to the vault.

Initiate an action e.g. cancel the in-progress failover

Did this page help you?

200Success

defaultError