What's new
Cohesity REST API v1.0
Overview
With its API driven architecture, Cohesity simplifies management of secondary data and applications. Cohesity REST API provides an interface to connect to the Cohesity Clusters. The RESTful APIs help you to build, automate and manage your workflows.
The scope of this document is to understand the usage of the REST APIs and use the the examples provided for each API to further test and use the APIs. For details on Cohesity clusters and working with the cluster, refer to Cohesity TechDocs.
What's New
Refer to the REST API table mentioned in Cohesity TechDocs under Release Notes > What is New to understand the list of newly added APIs, modified APIs and deprecated API list.
You can also refer to the following table for the newly added APIs in 6.4.1 Release.
| Resource | Method | Path | Summary |
|---|---|---|---|
| Certificates | GET | /public/certificates/global | List the certificates generated and deployed on hosts. |
| Certificates | POST | /public/certificates/global | Generate and deploy certificate for a single or multiple hosts. |
| Cluster | GET | /public/cluster/status | Get the status of a Cohesity Cluster. |
| Clusters | GET | /public/clusters/gflag | Get the gflags of a Cohesity Cluster. |
| Clusters | PUT | /public/clusters/gflag | Update the gflags of a Cohesity Cluster. |
| Clusters | PUT | /public/clusters/ioPreferentialTier | Update the IO preferential tiers and return the updated IO preferential tiers of the cluster. |
| Interface | PUT | /public/interface | Update an interface. |
| Monitoring | GET | /public/monitoring/jobRunInfo | List info related to a job run. |
| Monitoring | GET | /public/monitoring/objectDetails | List details of objects in a job run. |
| Network | DELETE | /public/network/ipConfig | Delete a new ipconfig entry from the Cluster. |
| Network | POST | /public/network/ipConfig | Create a new ipconfig entry on the Cluster. |
| Node | GET | /public/node/status | Sends a request to a Node to get the status of that node. |
| Restore | POST | /public/restore/adObjects | Searches for AD Objects that match the list of object guids, sam account names and distinguished names provided in the request. |
| Restore | GET | /public/restore/adObjects/searchResults | undefined |
| Restore | GET | /public/restore/files/fstats | Get the fstat information about file provided using query parameters. |
| Restore | POST | /public/restore/pointsForTimeRange | List Restore Points in a give time range. |
| Restore | GET | /public/restore/vms/directoryList | Get the directory list based on the given directory name and other query parameters. |
| ViewBoxes | DELETE | /public/viewBoxes/{id} | Delete a Domain (View Box). |