Cohesity

Cohesity Failover API

The Failover API from Cohesity — 9 operation(s) for failover.

GitHub OpenAPI
Business capability
Disaster Recovery & Resilience BC-4220.60

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /data-protect/failover/pollPlannedRuns Check whether failover planned runs are scheduled · Get the list of failover planned runs #
Ask an LLM
“Has the planned run for my failover been scheduled yet?”
“Can I poll several failover workflows at once for their planned run status?”
Tell an agent
Poll planned run status for failovers {failoverIds}.
Check if failover {failoverIds} has its planned run scheduled.
GET /data-protect/failover/views/{id} Get failover tasks of a View · Get View Failover #
Ask an LLM
“What failover tasks have run against a particular View?”
“Can I see the status of a View's failover?”
Tell an agent
Show failover tasks for View {id}.
Get the View failover history of {id}.
POST /data-protect/failover/views/{id} Start a View failover · Create View Failover Task #
Ask an LLM
“Can I fail over a View to its replica, either planned or unplanned?”
“What parameters does an unplanned View failover take?”
Tell an agent
Start a {type} failover for View {id}.
Run a planned failover of View {id} as type {type} with {plannedFailoverParams}.
POST /data-protect/failover/views/{id}/cancel Cancel an in-progress View failover · Cancel View Failover Task #
Ask an LLM
“Can I abort a View failover that's still running?”
“What stops a View failover task midway?”
Tell an agent destructive · confirm first
Cancel the View failover on {id}.
Abort the running failover task for View {id}.
POST /data-protect/failover/{id} Initiate a failover request · Initiate a failover request #
Ask an LLM
“How do I kick off a failover workflow between a source and replication cluster?”
“Which clusters need to be named when starting a failover?”
Tell an agent
Initiate failover {id} from {sourceCluster} to {replicationCluster}.
Start failover request {id}.
POST /data-protect/failover/{id}/backupActivation Activate backups on the replication cluster · Activate failover entity backup on replication clsuter #
Ask an LLM
“After failover, can I start backing up the failed-over objects on the replication cluster?”
“Can reverse replication be enabled when activating backups on the replica?”
Tell an agent
Activate backup for failover {id} on the replication cluster into protection group {protectionGroupId}.
Activate replica backups for failover {id} with reverse replication {enableReverseReplication}.
POST /data-protect/failover/{id}/backupDeactivation Deactivate backups on the source cluster · Deactivate failover entity backup on source clsuter #
Ask an LLM
“During failover, can I stop backups of the failed-over objects on the source cluster?”
“Can I keep the failover objects around when deactivating backup on the source?”
Tell an agent
Deactivate source backup for failover {id} toward replication cluster {replicationClusterId}.
Stop source-side backups in protection group {protectionGroupId} for failover {id}.
POST /data-protect/failover/{id}/cancel Cancel a failover workflow · Cancel failover workflow #
Ask an LLM
“Can I cancel a failover workflow before backup activation or deactivation has been called?”
“When is it too late to cancel a failover?”
Tell an agent destructive · confirm first
Cancel failover workflow {id}.
Abort the failover {id} before backups are switched.
POST /data-protect/failover/{id}/objectLinkage Link failover objects to replicated objects · Linking between replicated objects and failover objects #
Ask an LLM
“After recovering failed entities on the replica, how do I link them back to the replicated source objects?”
“What object map is needed to link failover objects?”
Tell an agent
Link failover objects for {id} using object map {objectMap}.
Record the object linkage for failover {id}.
POST /data-protect/failover/{id}/plannedRun Run a planned failover sync backup · Create a planned run for backup and replication #
Ask an LLM
“Can I trigger a final backup and replication run to sync clusters before a planned failover?”
“Can the planned failover run pause later scheduled runs or cancel other runs?”
Tell an agent
Create a planned run for failover {id} on group {protectionGroupId} with objects {objects} to cluster {replicationClusterId}.
Sync objects {objects} of group {protectionGroupId} to {replicationClusterId} for failover {id}, pausing next runs.

Documentation

📖
Documentation
https://developer.cohesity.com/helios-api.html
📖
GettingStarted
https://developer.cohesity.com/docs/helios-getting-started
📖
APIReference
https://developer.cohesity.com/apidocs/versions/
📖
Documentation
https://developer.cohesity.com/apidocs/versions/
📖
APIReference
https://developers.cohesity.com/page/api-reference
📖
GettingStarted
https://developers.cohesity.com/docs/getting-started
📖
Documentation
https://developer.cohesity.com/apidocs/helios-reporting
📖
Documentation
https://developer.cohesity.com/apidocs/site-continuity

Specifications

⚙
OpenAPI
https://artifacts.apis.io/cohesity/openapi/cohesity-failover-api-openapi.yml

Other Resources

🔗
Postman
https://api.cohesity.com/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cohesity:cohesity-failover-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cohesity-failover-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Cohesity API provides a RESTful interface to access the various data management operations on Cohesity cluster and Helios.
  title: Cohesity REST Failover API
  version: '2.0'
servers:
- url: /v2
tags:


# --- truncated at 32 KB (33 KB total) ---
# Full source: https://artifacts.apis.io/cohesity/openapi/cohesity-failover-api-openapi.yml