Cohesity

Cohesity Platform API

The Platform API from Cohesity — 26 operation(s) for platform.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 47

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 /alertsSummary Summarize cluster alerts by category · Get alerts summary #
Ask an LLM
“What does the alert summary for my Cohesity cluster look like, grouped by category?”
“Can I limit the alerts summary to a time window or specific alert states?”
Tell an agent
Show me the alert counts by category for the cluster.
Summarize alerts by category between {startTimeUsecs} and {endTimeUsecs}.
GET /chassis List the chassis in the cluster · Get list of chassis #
Ask an LLM
“Which hardware chassis are part of my cluster?”
“Can I find chassis that haven't been assigned to a rack yet?”
Tell an agent
List every chassis in the cluster.
List chassis where no rack assigned is {noRackAssigned}.
GET /chassis/{id} Get details of one chassis · Get a chassis by chassis id #
Ask an LLM
“What hardware model and serial number does a particular chassis have?”
“Which nodes and rack belong to a given chassis?”
Tell an agent
Show the details of chassis {id}.
Look up chassis {id} and tell me its serial number.
PATCH /chassis/{id} Update a chassis's name or rack assignment · Update a chassis by chassis id #
Ask an LLM
“How do I rename a chassis in my cluster?”
“Can I move a chassis to a different rack?”
Tell an agent
Rename chassis {id} to {name}.
Assign chassis {id} to rack {rackId}.
GET /clusters Get the cluster configuration summary · Retrieve Cluster Configuration #
Ask an LLM
“What is the current configuration of my Cohesity cluster?”
“Which software version and cluster type am I running?”
Tell an agent
Show me the cluster configuration summary.
Retrieve the cluster's name, type and software version.
PUT /clusters Update an existing cluster's configuration · Update a cluster #
Ask an LLM
“How do I change the name or description of an existing cluster?”
“Can I update the proxy server settings on a cluster that's already set up?”
Tell an agent
Rename the existing cluster to {name}.
Update the cluster description to {description}.
POST /clusters Create a new cluster · Create a cluster #
Ask an LLM
“How do I create a new physical, virtual or cloud cluster?”
“Is encryption something I have to decide when the cluster is first created?”
Tell an agent
Create a {type} cluster named {name} with encryption set to {enableEncryption} and network config {networkConfig}.
Build a new cluster called {name} of type {type} using physical params {physicalClusterParams}, encryption {enableEncryption}, network {networkConfig}.
GET /clusters/amqp-target-config View the cluster's AMQP target config · Get AMQP Target Config #
Ask an LLM
“Which AMQP server is my cluster sending messages to?”
“What exchange and virtual host are set in the AMQP target config?”
Tell an agent
Show the AMQP target configuration on the cluster.
Fetch the current AMQP server, exchange and virtual host settings.
PUT /clusters/amqp-target-config Set the cluster's AMQP target · Update AMQP Target Config #
Ask an LLM
“How do I point my cluster at an AMQP message broker?”
“Can I change the AMQP exchange or credentials the cluster uses?”
Tell an agent
Point the cluster's AMQP target at server {serverIp} with exchange {exchange}.
Update the AMQP target to use username {username} and virtual host {virtualHost}.
DELETE /clusters/amqp-target-config Remove the cluster's AMQP target · Delete AMQP Target Config #
Ask an LLM
“How do I stop the cluster from publishing to an AMQP broker?”
“Can I delete the AMQP target configuration entirely?”
Tell an agent destructive · confirm first
Delete the AMQP target configuration from the cluster.
Remove the AMQP broker settings on this cluster.
POST /disks/assimilate Assimilate free disks into the cluster · Assimilate disks #
Ask an LLM
“How do I add newly discovered free disks from nodes into cluster storage?”
“Can I assimilate disks from several nodes at once?”
Tell an agent
Assimilate the free disks {nodeFreeDisks} into the cluster.
Bring these node free disks into use: {nodeFreeDisks}.
GET /disks/discover Discover disks ready for activation · Discover new disks #
Ask an LLM
“Are there any new disks waiting to be activated in my cluster?”
“Which newly inserted disks has the cluster detected?”
Tell an agent
Discover new disks that are ready for activation.
Scan for disks I can activate.
POST /disks/identify Blink a disk's LED to locate it · Identify a disk #
Ask an LLM
“How can I find a physical disk in the rack by lighting its LED?”
“Can I turn a disk's identify light off again?”
Tell an agent
Turn the LED on for disk {serialNumber} on node {nodeId}, identify {identify}.
Set disk {serialNumber} on node {nodeId} identify light to {identify}.
GET /disks/local List local disks in the cluster · Get list of disks #
Ask an LLM
“What local disks are installed in my cluster nodes?”
“Can I see only the local disks on one node?”
Tell an agent
List all local disks.
List the local disks on node {nodeId}.
GET /disks/remote List remote disks attached to the cluster · Get remote disks #
Ask an LLM
“Which remote disks are attached to my cluster?”
“Can I filter remote disks by storage tier or mount path?”
Tell an agent
Show all remote disks.
List remote disks in tier {tiers} on nodes {nodeIds}.
POST /disks/remote Add a remote disk to the cluster · Add remote disk #
Ask an LLM
“How do I attach a remote disk to my cluster?”
“Can I add several remote disks in one request?”
Tell an agent
Add these remote disks to the cluster: {remoteDisks}.
Attach remote disk {remoteDisks}.
DELETE /disks/remote/{id} Remove a remote disk · Remove remote disk #
Ask an LLM
“How do I detach a remote disk from the cluster?”
“What happens when I remove a remote disk by its id?”
Tell an agent destructive · confirm first
Remove remote disk {id}.
Detach remote disk {id} from the cluster.
POST /disks/{id}/remove Mark a disk for removal or cancel it · Mark Disk for removal #
Ask an LLM
“How do I mark a failing local disk for removal?”
“Can I cancel a disk removal I already requested?”
Tell an agent destructive · confirm first
Mark disk {id} for removal with cancel set to {cancel}.
Cancel the pending removal of disk {id} by setting cancel to {cancel}.
GET /network-interfaces List network interfaces on nodes · Get list of interfaces #
Ask an LLM
“What network interfaces exist on my cluster nodes?”
“Which NICs does the cluster see right now?”
Tell an agent
List the network interfaces on the cluster.
Show me every node interface.
POST /nodePower Reboot or shut down cluster nodes · Reboot or shutdown nodes in cluster #
Ask an LLM
“How do I reboot a single node in my cluster?”
“Can I shut down the whole cluster through the API?”
Tell an agent destructive · confirm first
Run power operation {operation} on node {nodeId}.
Perform {operation} on all cluster nodes.
POST /nodes/{id}/identify Blink a node's LED to locate it · Identify node #
Ask an LLM
“How do I light up a node's LED so I can find it in the datacenter?”
“Can I switch off the identify light on a node?”
Tell an agent
Set the identify LED on node {id} to {identify}.
Blink node {id} so I can find it, identify {identify}.
POST /nodes/{id}/remove Mark a node for removal or cancel it · Mark Node for removal #
Ask an LLM
“How do I remove a node from my cluster?”
“Can I cancel a node removal that's already in progress?”
Tell an agent destructive · confirm first
Mark node {id} for removal, cancel {cancel}.
Cancel the removal of node {id} by setting cancel to {cancel}.
GET /racks List racks in the cluster · Get list of racks #
Ask an LLM
“Which racks are defined in my cluster?”
“What racks have I set up and where are they located?”
Tell an agent
List all racks in the cluster.
Show me every rack and its chassis.
POST /racks Create racks and assign chassis · Create racks #
Ask an LLM
“How do I define racks for my cluster hardware?”
“Can I assign chassis to a rack when I create it?”
Tell an agent
Create these racks: {racks}.
Add new racks with their chassis assignments {racks}.
DELETE /racks Delete all racks · Delete all the racks #
Ask an LLM
“How do I wipe every rack definition from the cluster at once?”
“Is there a way to delete all racks in one call?”
Tell an agent destructive · confirm first
Delete all the racks in the cluster.
Clear every rack definition.
PATCH /racks Bulk update several racks · Update racks #
Ask an LLM
“How do I update names and locations for several racks at once?”
“Can I change chassis lists across multiple racks in a single request?”
Tell an agent
Update these racks in bulk: {racks}.
Apply this list of rack name and location changes: {racks}.
GET /racks/{id} Get details of one rack · Get a rack by rack id #
Ask an LLM
“Where is a specific rack located and which chassis does it hold?”
“What's stored about one rack in the cluster?”
Tell an agent
Show rack {id}.
Get the location and chassis of rack {id}.
DELETE /racks/{id} Delete one rack · Delete a rack by id #
Ask an LLM
“How do I delete a single rack by its id?”
“Can I remove just one rack without touching the others?”
Tell an agent destructive · confirm first
Delete rack {id}.
Remove the rack with id {id}.
PATCH /racks/{id} Update one rack's name, location or chassis · Update rack by id #
Ask an LLM
“How do I rename a single rack?”
“Can I change the chassis assigned to one particular rack?”
Tell an agent
Rename rack {id} to {name}.
Set the location of rack {id} to {location}.
GET /remote-storage List registered remote storage servers · Get Registered Remote Storage Servers List #
Ask an LLM
“Which remote storage servers are registered for disaggregated storage?”
“What external storage arrays is my cluster using?”
Tell an agent
List registered remote storage servers.
Show the summary of all remote storage registrations.
POST /remote-storage Register remote storage · Register Remote Storage #
Ask an LLM
“How do I register a FlashBlade as remote storage for my cluster?”
“Can I add disaggregated storage from an external product?”
Tell an agent
Register remote storage of product {product} with FlashBlade params {flashbladeParams}.
Register a new {product} remote storage server.
GET /remote-storage/{id} Get details of a remote storage server · Get remote storage details #
Ask an LLM
“How much space is available on a registered remote storage array?”
“Can I see the data VIPs and array info for one remote storage registration?”
Tell an agent
Show remote storage {id}.
Get remote storage {id} including available space {includeAvailableSpace}.
DELETE /remote-storage/{id} Unregister remote storage · Delete Remote Storage Registration #
Ask an LLM
“How do I unregister a remote storage server from the cluster?”
“Can I delete a remote storage registration I no longer use?”
Tell an agent destructive · confirm first
Delete remote storage registration {id}.
Unregister remote storage {id}.
PATCH /remote-storage/{id} Update a remote storage registration · Update Remote Storage Config #
Ask an LLM
“How do I change the FlashBlade settings of a storage array I already registered?”
“Can I edit an existing remote storage config?”
Tell an agent
Update remote storage {id} as product {product} with FlashBlade params {flashbladeParams}.
Change the registered remote storage {id} config to product {product}.
GET /support-channel-config View the support channel configuration · Get support channel configuration #
Ask an LLM
“Is the remote support channel enabled on my cluster?”
“When does the current support channel session expire?”
Tell an agent
Show the support channel configuration.
Check whether the support channel is on.
PUT /support-channel-config Enable or disable the support channel · Update support channel configuration #
Ask an LLM
“How do I open a support channel for Cohesity support until a certain time?”
“Can I turn the support channel off?”
Tell an agent
Set the support channel enabled to {isEnabled} until {endTimeUsecs}.
Open the support channel with enabled {isEnabled}, ending at {endTimeUsecs}.
GET /syslogAuditTags View cluster syslog audit tags · Get cluster audit tags #
Ask an LLM
“What audit tags does the cluster attach to syslog messages?”
“Which tags are used for filer and alert audit logs?”
Tell an agent
Show the cluster's syslog audit tags.
List the audit tags for cluster, filer, data protection and alert logs.
POST /syslogAuditTags Change cluster syslog audit tags · Update cluster audit tags #
Ask an LLM
“How do I change the tag used for cluster audit messages sent to syslog?”
“Can I set a different audit tag for alerts?”
Tell an agent
Set the cluster audit tag to {clusterAudit}.
Change the alert audit tag to {alertAudit} and filer audit tag to {filerAudit}.
GET /syslogProgramNames List syslog program names you can forward · Get supported program names #
Ask an LLM
“Which program names can I configure a syslog server to receive?”
“What log sources are supported for syslog forwarding?”
Tell an agent
List the supported syslog program names.
Show which programs can be sent to a syslog server.
GET /syslogs List syslog servers · Get list of syslog servers #
Ask an LLM
“Which syslog servers is my cluster forwarding logs to?”
“What syslog destinations are configured?”
Tell an agent
List all configured syslog servers.
Show me every syslog destination.
POST /syslogs Add a syslog server · Add Syslog Server #
Ask an LLM
“How do I forward cluster logs to a new syslog server?”
“Can I send logs to syslog over TLS with a CA certificate?”
Tell an agent
Add syslog server {name} at {ip} port {port} over {protocol}.
Add a TLS syslog server at {ip} using CA certificate {caCertificate}.
DELETE /syslogs Delete all syslog servers · Remove syslog servers #
Ask an LLM
“How do I remove every syslog server at once?”
“Can I stop all syslog forwarding in one call?”
Tell an agent destructive · confirm first
Delete all syslog servers.
Clear every syslog destination from the cluster.
GET /syslogs/{id} Get one syslog server · Get a syslog server by id #
Ask an LLM
“What settings does a particular syslog server have?”
“Which facilities and programs is one syslog destination receiving?”
Tell an agent
Show syslog server {id}.
Get the config of syslog server {id}.
PUT /syslogs/{id} Replace a syslog server's settings · Update a syslog server by id #
Ask an LLM
“How do I fully replace the configuration of an existing syslog server?”
“Can I overwrite a syslog server's address, port and protocol together?”
Tell an agent
Replace syslog server {id} with address {ip} port {port} protocol {protocol}.
Overwrite the full config of syslog server {id}, naming it {name}.
DELETE /syslogs/{id} Delete one syslog server · Remove syslog server by id #
Ask an LLM
“How do I remove a single syslog server by id?”
“Can I delete one syslog destination and keep the rest?”
Tell an agent destructive · confirm first
Remove syslog server {id}.
Delete just the syslog destination {id}.
PATCH /syslogs/{id} Partially change a syslog server · Patch a syslog server by id #
Ask an LLM
“How do I disable one syslog server without changing its other settings?”
“Can I patch only the port of an existing syslog server?”
Tell an agent
Patch syslog server {id} to set enabled {enabled}.
Change only the port of syslog server {id} to {port}.
GET /syslogs/{id}/status Check a syslog server's reachability · Get a syslog server reachability status #
Ask an LLM
“Is my syslog server reachable from the cluster?”
“Why aren't logs arriving at a syslog destination — can I test reachability?”
Tell an agent
Check reachability of syslog server {id}.
Test whether syslog server {id} can be reached.

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-platform-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-platform-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-platform-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 Platform API
  version: '2.0'
servers:
- url: /v2
tags:


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