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 6.6.0x:
Newly Added APIs
| Resource | Method | Path | Summary |
|---|---|---|---|
| Bifrost | GET | /public/bifrost/vlans | List the Bifrost Tenant VLANs for the Cohesity Cluster. |
| Bifrost | POST | /public/bifrost/vlans | Creates a Bifrost VLAN of the Cohesity Cluster. |
| Idps | POST | /public/idps/principals | Add multiple groups or users on the Cohesity Cluster for the specified Idp principals. In addition, assign Cohesity roles to the users or groups to define their Cohesity privileges. |
| KmsConfig | DELETE | /public/kmsConfig/{id} | Delete a Kms configuration for a given id. |
| NfsConnections | GET | /public/nfsConnections | Fetches Nfs Connection Status of a view. |
| RemoteVaults | GET | /public/remoteVaults/cloudDomainMigration | Query the cloud domain migration. |
| RemoteVaults | POST | /public/remoteVaults/cloudDomainMigration | Schedules cloud domain migration. |
| Reports | GET | /public/reports/cloudArchiveReport | Get summary statistics about succesful/failed job runs, queued archival jobs |
| Users | PUT | /public/users/linuxPassword | Update linux user password. |
| Users | PUT | /public/users/linuxSupportUserBashShellAccess | Requests Linux 'support' user bash shell access. |
| Users | PUT | /public/users/linuxSupportUserSudoAccess | Requests Linux 'support' user sudo access. |
| Verify-otp | POST | /public/verify-otp | Verify the OTP code. |
| VirtualDatacenters | GET | /public/virtualDatacenters/{id}/orgVdcNetworks | Returns the Org VDC Network under a VDC in a VMware environment. |
Deprecated APIs
| Resource | Method | Path |
|---|---|---|
| Idp | POST | /public/idp/principals |