What's new
Cohesity REST API Documentation
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
The following section lists the newly added, modified and deprecated REST APIs for 7.0:
No Newly Added APIs
Modified APIs
| Resource | Method | Path | Summary |
|---|---|---|---|
| Alerts | GET | /public/alerts | List the Alerts on the Cohesity Cluster. |
| Apps | POST | /public/apps | Upload and install an app from image. |
| Cluster | PUT | /public/cluster | Update the configuration of this Cohesity Cluster. |
| KmsConfig | POST | /public/kmsConfig | Create a KMS config. |
| KmsConfig | PUT | /public/kmsConfig | Update KMS configurations in the cluster. |
| ProtectionJobs | POST | /public/protectionJobs | Create a Protection Job. |
| ProtectionJobs | PUT | /public/protectionJobs/{id} | Update a Protection Job. |
| ProtectionPolicies | POST | /public/protectionPolicies | Create a Protection Policy. |
| ProtectionPolicies | PUT | /public/protectionPolicies/{id} | Update a Protection Policy. |
| ProtectionSources | GET | /public/protectionSources | Returns the registered Protection Sources and their Object subtrees. |
| ProtectionSources | POST | /public/protectionSources/register | Register a Protection Source. |
| ProtectionSources | POST | /public/protectionSources/register | Register a Protection Source. |
| ProtectionSources | PATCH | /public/protectionSources/{id} | Update a previously registered Protection Source with new details. |
| ProtectionSources | PATCH | /public/protectionSources/{id} | Update a previously registered Protection Source with new details. |
| Restore | POST | /public/restore/recover | Create a Restore Task for recovering VMs or instantly mounting volumes. |
| Statistics | GET | /public/statistics/entities | Lists the entities for the specified schema. |
| Statistics | GET | /public/statistics/timeSeriesStats | List a series of data points for an entity of a metric in a schema, during the specified time period. |
| Tenants | POST | /public/tenants | Create/add a new tenant to the Cohesity Cluster. |
| Tenants | PUT | /public/tenants | Update an existing tenant on the Cohesity Cluster. |
| Users | PUT | /public/users | Update an existing user on the Cohesity Cluster. Only user settings on the Cohesity Cluster are updated. No changes are made to the referenced user principal on the Active Directory. |
| Vaults | POST | /public/vaults | Create a new Vault (External Target). |
| Vaults | PUT | /public/vaults/{id} | Update a Vault (External Target). |
| Views | POST | /public/views | Create a View. |
| Views | PUT | /public/views | Update a View. |
| Views | POST | /public/views/clone | Clone a View. |
| Views | PUT | /public/views/{name} | Update a View. |