Cohesity

  • API Docs
  • GitHub
  • Marketplace
  • Blog

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

ResourceMethodPathSummary
ActiveDirectoryPOST/public/activeDirectory/{name}/enableTrustedDomainStateUpdates the states of trusted domains discovery.
AlertCategoriesGET/public/alertCategoriesGet alert categories in the Cohesity cluster.
AlertNotificationRulesPOST/public/alertNotificationRulesCreates a new alert notification rule.
AlertNotificationRulesPUT/public/alertNotificationRulesUpdates an existing alert notification rule.
AlertNotificationRulesGET/public/alertNotificationRulesGets all alert notification rules.
AlertNotificationRulesDELETE/public/alertNotificationRules/{ruleId}Deletes an alert notification rule.
AlertTypesGET/public/alertTypesGet registered alerts in the Cohesity cluster.
AntivirusGroupsPUT/public/antivirusGroupsUpdate an antivirus service group.
AntivirusGroupsGET/public/antivirusGroupsLists the antivirus service groups.
AntivirusGroupsPOST/public/antivirusGroupsCreate an Antivirus service group.
AntivirusGroupsPUT/public/antivirusGroups/statesChange the state of an antivirus service group.
AntivirusGroupsDELETE/public/antivirusGroups/{id}Delete an antivirus service group corresponding to the specified antivirus
service group Id.
AppInstancesPOST/public/appInstancesStarts the application instance launch on the cluster.
AppInstancesGET/public/appInstancesLists the app instances.
AppInstancesPUT/public/appInstances/{appInstanceId}/statesUpdates app instance state.
AppInstanceSettingsPUT/public/appInstanceSettings/{appInstanceId}Updates app instance settings.
AppsPOST/public/appsUpload and install an app from image.
AppsGET/public/appsLists the apps.
AppsPOST/public/apps/{appUid}/versions/{version}Starts the application installation on the cluster.
AppsDELETE/public/apps/{appUid}/versions/{version}Starts the application uninstall from the cluster.
AuditLogsGET/public/auditLogs/actionsReturn list of audit log actions.
AuditLogsGET/public/auditLogs/categoriesReturn list of audit log categories.
BannersPUT/public/bannersUpdate an existing banner on the Cohesity Cluster.
BannersGET/public/bannersList the banner for a persona.
CertificatesGET/public/certificates/globalList the certificates generated and deployed on hosts.
CertificatesPOST/public/certificates/globalGenerate and deploy certificate for a single or multiple hosts.
ClusterGET/public/cluster/appSettingsGets the app settings for the cluster.
ClusterPUT/public/cluster/appSettingsUpdate the app settings of the cluster.
ClusterGET/public/cluster/backgroundActivityScheduleGet the Apollo Throttling schedule.
ClusterPUT/public/cluster/backgroundActivityScheduleUpdate the Apollo Throttling schedule.
ClusterGET/public/cluster/keysList the Public Keys for the cluster.
ClusterGET/public/cluster/statusGet the status of a Cohesity Cluster.
ClustersDELETE/public/clustersDestroy a Cohesity Cluster.
ClustersPOST/public/clusters/cloudEditionCreate a new Cloud Edition Cohesity Cluster.
ClustersPOST/public/clusters/cloudEdition/nodesExpand a Cloud Edition Cohesity Cluster.
ClustersGET/public/clusters/creationProgressCheck the progress of the creation of a new Cohesity Cluster.
ClustersPUT/public/clusters/ioPreferentialTierUpdate the IO preferential tiers and return the updated IO preferential
tiers of the cluster.
ClustersGET/public/clusters/ioPreferentialTierReturn the IO preferential tiers of the cluster.
ClustersDELETE/public/clusters/nodes/{id}Remove a Node from a Cohesity Cluster.
ClustersPOST/public/clusters/physicalEditionCreate a new Physical Edition Cohesity Cluster.
ClustersPOST/public/clusters/physicalEdition/nodesExpand a Physical Edition Cohesity Cluster.
ClustersGET/public/clusters/services/statesList the states of the services on the Cluster.
ClustersPOST/public/clusters/services/statesChange the state of one or more services on a Cohesity Cluster.
ClustersPUT/public/clusters/softwareUpgrade a Cohesity Cluster.
ClustersPOST/public/clusters/virtualEditionCreate a new Virtual Edition Cohesity Cluster.
ExternalClientSubnetsGET/public/externalClientSubnetsList the external Client Subnets for the cluster.
ExternalClientSubnetsPUT/public/externalClientSubnetsUpdate the external Client Subnet of the Cluster.
FreeNodesGET/public/freeNodesList the free Nodes present on a network.
IcapConnectionStatusGET/public/icapConnectionStatusCheck the Icap server connection status.
InfectedFilesPUT/public/infectedFilesUpdate the list of infected files.
InfectedFilesGET/public/infectedFilesLists the infected files.
InfectedFilesDELETE/public/infectedFilesDelete the list of infected files.
InterfaceGET/public/interfaceShow network interfaces.
InterfacePUT/public/interfaceUpdate an interface.
InterfaceGroupsPOST/public/interfaceGroupsCreate an interface group on the Cohesity Cluster.
InterfaceGroupsPUT/public/interfaceGroupsUpdate an interface group on the Cohesity Cluster.
InterfaceGroupsGET/public/interfaceGroupsList the interface groups for the Cohesity Cluster.
InterfaceGroupsDELETE/public/interfaceGroups/{name}Delete the specified interface group from the Cohesity Cluster.
IpDELETE/public/ipDelete the specified IP settings on the Cohesity Cluster.
IpPUT/public/ipConfigure the specfied IP settings on the Cohesity Cluster.
LicenseUsageGET/public/licenseUsageGet the current license usage of a Cohesity Cluster.
MonitoringGET/public/monitoring/jobRunInfoList info related to a job run.
MonitoringGET/public/monitoring/jobsList runs of all the jobs.
MonitoringGET/public/monitoring/objectDetailsList details of objects in a job run.
NetworkPOST/public/network/bondsCreate a new network bond.
NetworkDELETE/public/network/bonds/{name}Delete a network bond.
NetworkDELETE/public/network/hostsRemove entries from the /etc/hosts file.
NetworkPUT/public/network/hostsEdit entries in the Cluster's /etc/hosts file.
NetworkGET/public/network/hostsGet the current entries in the hosts file on the Cluster.
NetworkPOST/public/network/hostsAdd new entries to the /etc/hosts file.
NlmLocksDELETE/public/nlmLocksClear NLM locks that match the filter criteria specified using parameters.
NlmLocksGET/public/nlmLocksList the NLM locks that match the filter criteria specified using parameters.
NodeGET/public/node/statusSends a request to a Node to get the status of that node.
NodesPUT/public/nodes/softwareUpgrade the software on a Node.
PackagesGET/public/packagesList all currently installed packages on a Cohesity Cluster.
PackagesPOST/public/packages/urlDownload a package to the Cluster by providing a URL where the package is
hosted.
ProtectionJobsPOST/public/protectionJobs/statesPerform an action like pause, resume, activate, deactivate on all the specified
Protection Jobs.
ProtectionJobsGET/public/protectionJobs/{id}/auditTrailList a protection job audit.
ProtectionObjectsDELETE/public/protectionObjectsUnprotect a Protected Object.
ProtectionObjectsPUT/public/protectionObjectsUpdate a Protected Object.
ProtectionObjectsPOST/public/protectionObjectsProtect an Object.
ProtectionObjectsGET/public/protectionObjects/summaryProtect an Object.
ProtectionPolicySummaryGET/public/protectionPolicySummaryList Protection Policy Summary.
ProtectionRunsGET/public/protectionRuns/errorsList Protection Job Run Errors filtered by the specified parameters.
ProtectionSourcesPOST/public/protectionSources/diagnostics/{id}Collect diagnostics of the protection source for a host type.
ProtectionSourcesGET/public/protectionSources/downloadCftFileDownload the CFT.
ProtectionSourcesGET/public/protectionSources/exchangeDagHosts-
ProtectionSourcesDELETE/public/protectionSources/{id}Unregister a previously registered Protection Source.
ProtectionSourcesPATCH/public/protectionSources/{id}Update a previously registered Protection Source with new details.
QosPoliciesGET/public/qosPoliciesFetches QoS Policies of a view.
RestoreGET/public/restore/adDomainRootTopologyGets Root Topology for an AD Domain.
RestorePOST/public/restore/adObjectAttributesCompares the AD Object from both Snapshot and Production AD and returns
the attributes with status whether they differ or not.
RestoreGET/public/restore/adObjectsSearches for AD Objects in both Production and Snapshot AD from given search
base dn and offset.
RestorePOST/public/restore/adObjectsSearches for AD Objects that match the list of object guids,
sam account names and distinguished names provided in the request.
RestoreGET/public/restore/adObjects/searchResults-
RestoreGET/public/restore/adObjects/status-
RestorePOST/public/restore/applicationsClone/refreshCreate a Clone Refresh Task to refresh the clone with the new data.
RestoreDELETE/public/restore/clone/{id}Destroy a clone task with specified id.
RestorePOST/public/restore/deployCreate a Restore Task for deploying VMs or a View on cloud.
RestoreGET/public/restore/files/fstatsGet the fstat information about file provided using query parameters.
RestoreGET/public/restore/office365/onedrive/documentsReturns the OneDrive files and folders.
RestoreGET/public/restore/office365/sharepoint/documentsReturns the Sharepoint Site's files and folders.
RestorePOST/public/restore/pointsForTimeRangeList Restore Points in a give time range.
RestorePUT/public/restore/recover-
RestoreGET/public/restore/vms/directoryListGet the directory list based on the given directory name and other
query parameters.
SessionUserPATCH/public/sessionUser/preferencesUpdate specific preferences of the session user
SmbConnectionsGET/public/smbConnectionsFetches Smb Connection Status of a view.
StatisticsGET/public/statistics/timeSeriesSchema-
StatsGET/public/stats/alertsCompute the statistics on the active Alerts generated on the cluster.
StatsGET/public/stats/consumersGets the statistics of consumers.
StatsGET/public/stats/filesCompute the file distribution statistics on a given entity like cluster
or storage domain.
StatsGET/public/stats/protectionRunsCompute the statistics on the Protection Runs for the cluster.
StatsGET/public/stats/protectionRuns/lastRunCompute stats on last Protection Run for every job.
StatsGET/public/stats/protectionSummaryComputes the protected objects summary on the cluster.
StatsGET/public/stats/restoresCompute the statistics on the Restore tasks on the cluster.
StatsGET/public/stats/storageComputes the storage stats on the cluster.
StatsGET/public/stats/tenantsGets the statistics of organizations (tenant).
StatsGET/public/stats/vaultsCompute the statistics on vaults.
StatsGET/public/stats/vaults/providersCompute the size and count of entities on vaults.
StatsGET/public/stats/vaults/runsCompute the statistics on protection runs to or from a vault.
StatsGET/public/stats/viewBoxesGets the statistics of view boxes (storage domain).
StatsGET/public/stats/viewsCompute the statistics on Views.
StatsGET/public/stats/views/protocolsCompute the protocol statistics on Views.
TagsPUT/public/tags/applyApply Tags on existing objects in the Cohesity Cluster.
TagsPUT/public/tags/removeRemove Tags on existing objects in the Cohesity Cluster.
TasksGET/public/tasks/statusGets the progress and status of tasks.
TenantsPUT/public/tenants/activeDirectoryUpdate Active Directory for an existing tenant on the Cohesity Cluster.
TenantsPUT/public/tenants/groupsUpdate existing groups to an existing tenant on the Cohesity Cluster.
TenantsPUT/public/tenants/ldapProviderUpdate Ldap Providers for an existing tenant on the Cohesity Cluster.
TenantsGET/public/tenants/proxiesList proxies for tenant which are running within tenant's environment.
TenantsGET/public/tenants/proxy/configGet proxy config for tenant.
TenantsGET/public/tenants/proxy/imageDownloads the tenants proxy.
UsersPOST/public/users/{sid}/apiKeysCreate an API key for user.
UsersGET/public/users/{sid}/apiKeysFetch API keys for user.
UsersGET/public/users/{sid}/apiKeys/{id}Fetch an API key for user by its id.
UsersPUT/public/users/{sid}/apiKeys/{id}Update an API key.
UsersDELETE/public/users/{sid}/apiKeys/{id}Delete an API key for user.
UsersPOST/public/users/{sid}/apiKeys/{id}/rotateFetch an API key for user by its id.
UsersApiKeysGET/public/usersApiKeysFetch API keys across all users.
ViewAliasesPUT/public/viewAliasesUpdate a View Alias. A View Alias allows a directory inside the view to be
mounted without specifying the entire path.
ViewBoxesDELETE/public/viewBoxes/{id}Delete a Domain (View Box).
ViewDirectoryQuotasGET/public/viewDirectoryQuotasGets directory quota info for a view. Returns error if op fails.
ViewDirectoryQuotasPUT/public/viewDirectoryQuotasUpdates a directory quota policy for a view. Returns error if op fails.
ViewsGET/public/views/id/{id}List details about a single View.
ViewsDELETE/public/views/id/{id}Delete a View.
ViewsGET/public/views/id/{id}/fileLocksFetches the lock status of a file in a view.
ViewsPOST/public/views/id/{id}/fileLocksLock a file in a view and optionally update its expiry timestamp.
ViewsPOST/public/views/rename/id/{id}Rename a View.
VirtualDatacentersGET/public/virtualDatacenters/{id}/storageProfilesFetches information of virtual disk.

Deprecated APIs

ResourceMethodPath
ExportPOST/public/export/config
ImportPUT/public/import/config
ReportsGET/public/reports/restoreSummaryByObjectType
StaticRoutesGET/public/staticRoutes
StaticRoutesDELETE/public/staticRoutes/{}
StaticRoutesPUT/public/staticRoutes/{}
  • Overview
  • What's New
    • Newly Added APIs
    • Deprecated APIs
Copyright © 2023 Cohesity, Inc. All Rights Reserved.
Privacy Policy | Legal | cohesity.com | 1-855-9COHESITY