Cohesity

Cohesity Clusters API

The Clusters API from Cohesity — 14 operation(s) for clusters.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 18

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 /public/cluster/backgroundActivitySchedule Show the background activity throttling schedule · Get the Apollo Throttling schedule #
Ask an LLM
“When does the cluster throttle background tasks like garbage collection?”
“What Apollo throttling windows are set on my cluster right now?”
Tell an agent
Show the cluster's background activity throttling schedule.
Get the current Apollo throttling settings.
PUT /public/cluster/backgroundActivitySchedule Change the background activity throttling schedule · Update the Apollo Throttling schedule #
Ask an LLM
“Can I move background maintenance work to off-hours so it doesn't slow backups?”
“How do I change when Apollo throttling kicks in?”
Tell an agent
Update the cluster's background activity throttling schedule.
Change the Apollo throttling windows to run only overnight.
GET /public/cluster/keys List the cluster's public keys · List the Public Keys for the cluster #
Ask an LLM
“Where can I find the public keys my cluster uses?”
“Does the cluster expose its public keys for configuring trust?”
Tell an agent
List the cluster's public keys.
Show me the public keys for this cluster.
DELETE /public/clusters Destroy a Cohesity cluster · Destroy a Cohesity Cluster #
Ask an LLM
“Is it possible to completely tear down a cluster and wipe its nodes?”
“What does destroying a cluster report back about each node?”
Tell an agent destructive · confirm first
Destroy this Cohesity cluster.
Tear down the cluster and report the status of each node.
POST /public/clusters/cloudEdition Create a Cloud Edition cluster · Create a new Cloud Edition Cohesity Cluster #
Ask an LLM
“How do I stand up a new Cloud Edition cluster on cloud VMs?”
“Can I enable encryption and set metadata fault tolerance when creating a Cloud Edition cluster?”
Tell an agent
Create a Cloud Edition cluster named {clusterName} on nodes {nodeIps}.
Create Cloud Edition cluster {clusterName} with network config {networkConfig} and nodes {nodeIps}.
POST /public/clusters/cloudEdition/nodes Add nodes to a Cloud Edition cluster · Expand a Cloud Edition Cohesity Cluster #
Ask an LLM
“Can I grow an existing Cloud Edition cluster by adding more cloud nodes?”
“What do I need to supply to expand a Cloud Edition cluster?”
Tell an agent
Expand the Cloud Edition cluster with nodes at {nodeIps}.
Add cloud nodes {nodeIps} to my Cloud Edition cluster.
GET /public/clusters/creationProgress Check cluster creation progress · Check the progress of the creation of a new Cohesity Cluster #
Ask an LLM
“How far along is my new cluster's creation, and how long is left?”
“What percentage complete is the cluster setup?”
Tell an agent
Check the progress of the cluster that's being created.
Show the estimated time remaining for cluster creation.
GET /public/clusters/ioPreferentialTier Show the IO preferential storage tiers · Return the IO preferential tiers of the cluster #
Ask an LLM
“Which storage tiers does the cluster prefer for random versus sequential IO?”
“What are the current IO preferential tier settings?”
Tell an agent
Show the cluster's IO preferential tiers.
Get the preferred storage tiers for each IO workload.
PUT /public/clusters/ioPreferentialTier Change the IO preferential storage tiers · Update the IO preferential tiers and return the updated IO preferential tiers… #
Ask an LLM
“Can I make random IO prefer SSD over HDD on the cluster?”
“How do I set down-tier usage thresholds for each storage tier?”
Tell an agent
Set the random IO preferred tiers to {randomIOPreferentialTier}.
Set the sequential IO preferred tier to {sequentialIOPreferentialTier}.
DELETE /public/clusters/nodes/{id} Remove a node from the cluster · Remove a Node from a Cohesity Cluster #
Ask an LLM
“How do I decommission one node from my cluster?”
“Can I take a failing node out of the cluster?”
Tell an agent destructive · confirm first
Remove node {id} from the cluster.
Decommission cluster node {id}.
POST /public/clusters/physicalEdition Create a Physical Edition cluster · Create a new Physical Edition Cohesity Cluster #
Ask an LLM
“How do I create a new cluster on physical appliances, including IPMI setup?”
“Can I allow the cluster to be destroyed later with an HMAC-validated OTP when I create it?”
Tell an agent
Create a Physical Edition cluster named {clusterName} from nodes {nodeConfigs}.
Create physical cluster {clusterName} with IPMI config {ipmiConfig} and network config {networkConfig}.
POST /public/clusters/physicalEdition/nodes Add nodes to a Physical Edition cluster · Expand a Physical Edition Cohesity Cluster #
Ask an LLM
“Can I add new physical nodes and virtual IPs to an existing appliance cluster?”
“How do I map chassis serials to racks when expanding a physical cluster?”
Tell an agent
Expand the physical cluster with nodes {nodeConfigs}.
Add physical nodes {nodeConfigs} and virtual IPs {vips} to the cluster.
GET /public/clusters/services/states List service states on the cluster · List the states of the services on the Cluster #
Ask an LLM
“Which cluster services are running and which are stopped?”
“Is every service on my cluster healthy and up?”
Tell an agent
List the states of all services on the cluster.
Show me which cluster services are stopped.
POST /public/clusters/services/states Start, stop or restart cluster services · Change the state of one or more services on a Cohesity Cluster #
Ask an LLM
“Can I restart a single service on the cluster without rebooting nodes?”
“What happens if I stop services without naming any?”
Tell an agent
Restart cluster services {services}.
Apply action {action} to services {services}.
PUT /public/clusters/software Upgrade the cluster software · Upgrade a Cohesity Cluster #
Ask an LLM
“How do I upgrade my cluster to a newer software version?”
“Do I need to upload a package first before upgrading the cluster?”
Tell an agent
Upgrade the cluster to software version {targetSwVersion}.
Start a cluster software upgrade to {targetSwVersion}.
POST /public/clusters/virtualEdition Create a Virtual Edition cluster · Create a new Virtual Edition Cohesity Cluster #
Ask an LLM
“How do I create a Virtual Edition cluster on hypervisor VMs?”
“Can I configure encryption when setting up a Virtual Edition cluster?”
Tell an agent
Create a Virtual Edition cluster named {clusterName} with nodes {nodeConfigs}.
Create virtual cluster {clusterName} using network config {networkConfig}.
GET /public/externalClientSubnets List external client subnets · List the external Client Subnets for the cluster #
Ask an LLM
“Which external client subnets are allowed to reach the cluster?”
“What client subnets are configured on this cluster?”
Tell an agent
List the cluster's external client subnets.
Show the configured client subnets.
PUT /public/externalClientSubnets Update external client subnets · Update the external Client Subnet of the Cluster #
Ask an LLM
“Can I add a new client subnet so another network can access the cluster?”
“How do I change the external client subnets list?”
Tell an agent
Set the cluster's external client subnets to {clientSubnets}.
Update the external client subnets on the cluster.

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://raw.githubusercontent.com/api-evangelist/cohesity/refs/heads/main/openapi/cohesity-clusters-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-clusters-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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-clusters-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: 'This API list provides operations for interfacing with the Cohesity

    Cluster.'
  title: Cohesity REST Clusters API
  version: '1.0'
servers:
- url: https://<CLUSTER_VIP>/irisservices/api/v1
tags:


# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cohesity/refs/heads/main/openapi/cohesity-clusters-api-openapi.yml