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.5.1:
Newly Added APIs
| Resource | Method | Path | Summary |
|---|---|---|---|
| ActiveDirectory | POST | /public/activeDirectory/{name}/enableTrustedDomainState | Updates the states of trusted domains discovery. |
| AlertCategories | GET | /public/alertCategories | Get alert categories in the Cohesity cluster. |
| AlertNotificationRules | POST | /public/alertNotificationRules | Creates a new alert notification rule. |
| AlertNotificationRules | PUT | /public/alertNotificationRules | Updates an existing alert notification rule. |
| AlertNotificationRules | GET | /public/alertNotificationRules | Gets all alert notification rules. |
| AlertNotificationRules | DELETE | /public/alertNotificationRules/{ruleId} | Deletes an alert notification rule. |
| AlertTypes | GET | /public/alertTypes | Get registered alerts in the Cohesity cluster. |
| AntivirusGroups | PUT | /public/antivirusGroups | Update an antivirus service group. |
| AntivirusGroups | GET | /public/antivirusGroups | Lists the antivirus service groups. |
| AntivirusGroups | POST | /public/antivirusGroups | Create an Antivirus service group. |
| AntivirusGroups | PUT | /public/antivirusGroups/states | Change the state of an antivirus service group. |
| AntivirusGroups | DELETE | /public/antivirusGroups/{id} | Delete an antivirus service group corresponding to the specified antivirus |
| service group Id. | |||
| AppInstances | POST | /public/appInstances | Starts the application instance launch on the cluster. |
| AppInstances | GET | /public/appInstances | Lists the app instances. |
| AppInstances | PUT | /public/appInstances/{appInstanceId}/states | Updates app instance state. |
| AppInstanceSettings | PUT | /public/appInstanceSettings/{appInstanceId} | Updates app instance settings. |
| Apps | POST | /public/apps | Upload and install an app from image. |
| Apps | GET | /public/apps | Lists the apps. |
| Apps | POST | /public/apps/{appUid}/versions/{version} | Starts the application installation on the cluster. |
| Apps | DELETE | /public/apps/{appUid}/versions/{version} | Starts the application uninstall from the cluster. |
| AuditLogs | GET | /public/auditLogs/actions | Return list of audit log actions. |
| AuditLogs | GET | /public/auditLogs/categories | Return list of audit log categories. |
| Banners | PUT | /public/banners | Update an existing banner on the Cohesity Cluster. |
| Banners | GET | /public/banners | List the banner for a persona. |
| 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/appSettings | Gets the app settings for the cluster. |
| Cluster | PUT | /public/cluster/appSettings | Update the app settings of the cluster. |
| Cluster | GET | /public/cluster/backgroundActivitySchedule | Get the Apollo Throttling schedule. |
| Cluster | PUT | /public/cluster/backgroundActivitySchedule | Update the Apollo Throttling schedule. |
| Cluster | GET | /public/cluster/keys | List the Public Keys for the cluster. |
| Cluster | GET | /public/cluster/status | Get the status of a Cohesity Cluster. |
| Clusters | DELETE | /public/clusters | Destroy a Cohesity Cluster. |
| Clusters | POST | /public/clusters/cloudEdition | Create a new Cloud Edition Cohesity Cluster. |
| Clusters | POST | /public/clusters/cloudEdition/nodes | Expand a Cloud Edition Cohesity Cluster. |
| Clusters | GET | /public/clusters/creationProgress | Check the progress of the creation of a new Cohesity Cluster. |
| Clusters | PUT | /public/clusters/ioPreferentialTier | Update the IO preferential tiers and return the updated IO preferential |
| tiers of the cluster. | |||
| Clusters | GET | /public/clusters/ioPreferentialTier | Return the IO preferential tiers of the cluster. |
| Clusters | DELETE | /public/clusters/nodes/{id} | Remove a Node from a Cohesity Cluster. |
| Clusters | POST | /public/clusters/physicalEdition | Create a new Physical Edition Cohesity Cluster. |
| Clusters | POST | /public/clusters/physicalEdition/nodes | Expand a Physical Edition Cohesity Cluster. |
| Clusters | GET | /public/clusters/services/states | List the states of the services on the Cluster. |
| Clusters | POST | /public/clusters/services/states | Change the state of one or more services on a Cohesity Cluster. |
| Clusters | PUT | /public/clusters/software | Upgrade a Cohesity Cluster. |
| Clusters | POST | /public/clusters/virtualEdition | Create a new Virtual Edition Cohesity Cluster. |
| ExternalClientSubnets | GET | /public/externalClientSubnets | List the external Client Subnets for the cluster. |
| ExternalClientSubnets | PUT | /public/externalClientSubnets | Update the external Client Subnet of the Cluster. |
| FreeNodes | GET | /public/freeNodes | List the free Nodes present on a network. |
| IcapConnectionStatus | GET | /public/icapConnectionStatus | Check the Icap server connection status. |
| InfectedFiles | PUT | /public/infectedFiles | Update the list of infected files. |
| InfectedFiles | GET | /public/infectedFiles | Lists the infected files. |
| InfectedFiles | DELETE | /public/infectedFiles | Delete the list of infected files. |
| Interface | GET | /public/interface | Show network interfaces. |
| Interface | PUT | /public/interface | Update an interface. |
| InterfaceGroups | POST | /public/interfaceGroups | Create an interface group on the Cohesity Cluster. |
| InterfaceGroups | PUT | /public/interfaceGroups | Update an interface group on the Cohesity Cluster. |
| InterfaceGroups | GET | /public/interfaceGroups | List the interface groups for the Cohesity Cluster. |
| InterfaceGroups | DELETE | /public/interfaceGroups/{name} | Delete the specified interface group from the Cohesity Cluster. |
| Ip | DELETE | /public/ip | Delete the specified IP settings on the Cohesity Cluster. |
| Ip | PUT | /public/ip | Configure the specfied IP settings on the Cohesity Cluster. |
| LicenseUsage | GET | /public/licenseUsage | Get the current license usage of a Cohesity Cluster. |
| Monitoring | GET | /public/monitoring/jobRunInfo | List info related to a job run. |
| Monitoring | GET | /public/monitoring/jobs | List runs of all the jobs. |
| Monitoring | GET | /public/monitoring/objectDetails | List details of objects in a job run. |
| Network | POST | /public/network/bonds | Create a new network bond. |
| Network | DELETE | /public/network/bonds/{name} | Delete a network bond. |
| Network | DELETE | /public/network/hosts | Remove entries from the /etc/hosts file. |
| Network | PUT | /public/network/hosts | Edit entries in the Cluster's /etc/hosts file. |
| Network | GET | /public/network/hosts | Get the current entries in the hosts file on the Cluster. |
| Network | POST | /public/network/hosts | Add new entries to the /etc/hosts file. |
| NlmLocks | DELETE | /public/nlmLocks | Clear NLM locks that match the filter criteria specified using parameters. |
| NlmLocks | GET | /public/nlmLocks | List the NLM locks that match the filter criteria specified using parameters. |
| Node | GET | /public/node/status | Sends a request to a Node to get the status of that node. |
| Nodes | PUT | /public/nodes/software | Upgrade the software on a Node. |
| Packages | GET | /public/packages | List all currently installed packages on a Cohesity Cluster. |
| Packages | POST | /public/packages/url | Download a package to the Cluster by providing a URL where the package is |
| hosted. | |||
| ProtectionJobs | POST | /public/protectionJobs/states | Perform an action like pause, resume, activate, deactivate on all the specified |
| Protection Jobs. | |||
| ProtectionJobs | GET | /public/protectionJobs/{id}/auditTrail | List a protection job audit. |
| ProtectionObjects | DELETE | /public/protectionObjects | Unprotect a Protected Object. |
| ProtectionObjects | PUT | /public/protectionObjects | Update a Protected Object. |
| ProtectionObjects | POST | /public/protectionObjects | Protect an Object. |
| ProtectionObjects | GET | /public/protectionObjects/summary | Protect an Object. |
| ProtectionPolicySummary | GET | /public/protectionPolicySummary | List Protection Policy Summary. |
| ProtectionRuns | GET | /public/protectionRuns/errors | List Protection Job Run Errors filtered by the specified parameters. |
| ProtectionSources | POST | /public/protectionSources/diagnostics/{id} | Collect diagnostics of the protection source for a host type. |
| ProtectionSources | GET | /public/protectionSources/downloadCftFile | Download the CFT. |
| ProtectionSources | GET | /public/protectionSources/exchangeDagHosts | - |
| ProtectionSources | DELETE | /public/protectionSources/{id} | Unregister a previously registered Protection Source. |
| ProtectionSources | PATCH | /public/protectionSources/{id} | Update a previously registered Protection Source with new details. |
| QosPolicies | GET | /public/qosPolicies | Fetches QoS Policies of a view. |
| Restore | GET | /public/restore/adDomainRootTopology | Gets Root Topology for an AD Domain. |
| Restore | POST | /public/restore/adObjectAttributes | Compares the AD Object from both Snapshot and Production AD and returns |
| the attributes with status whether they differ or not. | |||
| Restore | GET | /public/restore/adObjects | Searches for AD Objects in both Production and Snapshot AD from given search |
| base dn and offset. | |||
| 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 | - |
| Restore | GET | /public/restore/adObjects/status | - |
| Restore | POST | /public/restore/applicationsClone/refresh | Create a Clone Refresh Task to refresh the clone with the new data. |
| Restore | DELETE | /public/restore/clone/{id} | Destroy a clone task with specified id. |
| Restore | POST | /public/restore/deploy | Create a Restore Task for deploying VMs or a View on cloud. |
| Restore | GET | /public/restore/files/fstats | Get the fstat information about file provided using query parameters. |
| Restore | GET | /public/restore/office365/onedrive/documents | Returns the OneDrive files and folders. |
| Restore | GET | /public/restore/office365/sharepoint/documents | Returns the Sharepoint Site's files and folders. |
| Restore | POST | /public/restore/pointsForTimeRange | List Restore Points in a give time range. |
| Restore | PUT | /public/restore/recover | - |
| Restore | GET | /public/restore/vms/directoryList | Get the directory list based on the given directory name and other |
| query parameters. | |||
| SessionUser | PATCH | /public/sessionUser/preferences | Update specific preferences of the session user |
| SmbConnections | GET | /public/smbConnections | Fetches Smb Connection Status of a view. |
| Statistics | GET | /public/statistics/timeSeriesSchema | - |
| Stats | GET | /public/stats/alerts | Compute the statistics on the active Alerts generated on the cluster. |
| Stats | GET | /public/stats/consumers | Gets the statistics of consumers. |
| Stats | GET | /public/stats/files | Compute the file distribution statistics on a given entity like cluster |
| or storage domain. | |||
| Stats | GET | /public/stats/protectionRuns | Compute the statistics on the Protection Runs for the cluster. |
| Stats | GET | /public/stats/protectionRuns/lastRun | Compute stats on last Protection Run for every job. |
| Stats | GET | /public/stats/protectionSummary | Computes the protected objects summary on the cluster. |
| Stats | GET | /public/stats/restores | Compute the statistics on the Restore tasks on the cluster. |
| Stats | GET | /public/stats/storage | Computes the storage stats on the cluster. |
| Stats | GET | /public/stats/tenants | Gets the statistics of organizations (tenant). |
| Stats | GET | /public/stats/vaults | Compute the statistics on vaults. |
| Stats | GET | /public/stats/vaults/providers | Compute the size and count of entities on vaults. |
| Stats | GET | /public/stats/vaults/runs | Compute the statistics on protection runs to or from a vault. |
| Stats | GET | /public/stats/viewBoxes | Gets the statistics of view boxes (storage domain). |
| Stats | GET | /public/stats/views | Compute the statistics on Views. |
| Stats | GET | /public/stats/views/protocols | Compute the protocol statistics on Views. |
| Tags | PUT | /public/tags/apply | Apply Tags on existing objects in the Cohesity Cluster. |
| Tags | PUT | /public/tags/remove | Remove Tags on existing objects in the Cohesity Cluster. |
| Tasks | GET | /public/tasks/status | Gets the progress and status of tasks. |
| Tenants | PUT | /public/tenants/activeDirectory | Update Active Directory for an existing tenant on the Cohesity Cluster. |
| Tenants | PUT | /public/tenants/groups | Update existing groups to an existing tenant on the Cohesity Cluster. |
| Tenants | PUT | /public/tenants/ldapProvider | Update Ldap Providers for an existing tenant on the Cohesity Cluster. |
| Tenants | GET | /public/tenants/proxies | List proxies for tenant which are running within tenant's environment. |
| Tenants | GET | /public/tenants/proxy/config | Get proxy config for tenant. |
| Tenants | GET | /public/tenants/proxy/image | Downloads the tenants proxy. |
| Users | POST | /public/users/{sid}/apiKeys | Create an API key for user. |
| Users | GET | /public/users/{sid}/apiKeys | Fetch API keys for user. |
| Users | GET | /public/users/{sid}/apiKeys/{id} | Fetch an API key for user by its id. |
| Users | PUT | /public/users/{sid}/apiKeys/{id} | Update an API key. |
| Users | DELETE | /public/users/{sid}/apiKeys/{id} | Delete an API key for user. |
| Users | POST | /public/users/{sid}/apiKeys/{id}/rotate | Fetch an API key for user by its id. |
| UsersApiKeys | GET | /public/usersApiKeys | Fetch API keys across all users. |
| ViewAliases | PUT | /public/viewAliases | Update a View Alias. A View Alias allows a directory inside the view to be |
| mounted without specifying the entire path. | |||
| ViewBoxes | DELETE | /public/viewBoxes/{id} | Delete a Domain (View Box). |
| ViewDirectoryQuotas | GET | /public/viewDirectoryQuotas | Gets directory quota info for a view. Returns error if op fails. |
| ViewDirectoryQuotas | PUT | /public/viewDirectoryQuotas | Updates a directory quota policy for a view. Returns error if op fails. |
| Views | GET | /public/views/id/{id} | List details about a single View. |
| Views | DELETE | /public/views/id/{id} | Delete a View. |
| Views | GET | /public/views/id/{id}/fileLocks | Fetches the lock status of a file in a view. |
| Views | POST | /public/views/id/{id}/fileLocks | Lock a file in a view and optionally update its expiry timestamp. |
| Views | POST | /public/views/rename/id/{id} | Rename a View. |
| VirtualDatacenters | GET | /public/virtualDatacenters/{id}/storageProfiles | Fetches information of virtual disk. |
Deprecated APIs
| Resource | Method | Path |
|---|---|---|
| Export | POST | /public/export/config |
| Import | PUT | /public/import/config |
| Reports | GET | /public/reports/restoreSummaryByObjectType |
| StaticRoutes | GET | /public/staticRoutes |
| StaticRoutes | DELETE | /public/staticRoutes/{} |
| StaticRoutes | PUT | /public/staticRoutes/{} |