Cohesity DataProtect REST API
The DataProtect REST API is the per-cluster RESTful interface exposed by every Cohesity cluster, providing programmatic control over data management operations including backups, restores, replication, archival, cloud tiering, and storage domain management. Authentication is performed via API keys for automation users or username/password for interactive sessions.
Operations 379
Showing the first 250 of 379. The full set is in the contract, and via get_provider_operations.
GET
/public/activeDirectory/centrifyZones
Fetches the list centrify zones of an active directory domain.
#
GET
/public/activeDirectory/principals
List the user and group principals in the Active Directory that match the filter criteria specified using parameters.
#
POST
/public/activeDirectory/principals
Add multiple groups or users on the Cohesity Cluster for the specified Active Directory principals. In addition, assign Cohesity roles to the users or groups to define their Cohesi
#
POST
/public/activeDirectory/{name}/enableTrustedDomainState
Updates the states of trusted domains discovery.
#
PUT
/public/activeDirectory/{name}/idMappingInfo
Updates the user id mapping info of an Active Directory.
#
PUT
/public/activeDirectory/{name}/ignoredTrustedDomains
Updates the list of trusted domains to be ignored during trusted domain discovery of an Active Directory.
#
PUT
/public/activeDirectory/{name}/ldapProvider
Updates the LDAP provide Id for an Active Directory domain.
#
POST
/public/activeDirectory/{name}/machineAccounts
Updates the machine accounts of an Active Directory.
#
GET
/public/analytics/mrAppRuns
List map reduce application runs filtered by the specified parameters.
#
GET
/public/analytics/mrFileFormats
Used to retrieve supported output file formats from a map reduce instance.
#
GET
/public/analytics/supportedPatterns
Used to retrieve supported patterns available for search in an application.
#
DELETE
/public/antivirusGroups/{id}
Delete an antivirus service group corresponding to the specified antivirus service group Id.
#
DELETE
/public/apps/{appUid}/versions/{version}
Starts the application uninstall from the cluster.
#
GET
/public/auditLogs/cluster
Lists the cluster audit logs on the Cohesity Cluster that match the filter criteria specified using parameters.
#
GET
/public/basicClusterInfo
List details about the Cohesity Cluster such as the name, type, version, language, locale and domains. This operation does not require authentication.
#
GET
/public/clusters/creationProgress
Check the progress of the creation of a new Cohesity Cluster.
#
PUT
/public/clusters/ioPreferentialTier
Update the IO preferential tiers and return the updated IO preferential tiers of the cluster.
#
POST
/public/clusters/services/states
Change the state of one or more services on a Cohesity Cluster.
#
GET
/public/dashboard
Returns the dashboard that match the filter criteria specified using parameters.
#
PUT
/public/groups
Update an existing group on the Cohesity Cluster. Only group settings on the Cohesity Cluster are updated. No changes are made to the referenced group principal on the Active Direc
#
POST
/public/idp/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
#
DELETE
/public/interfaceGroups/{name}
Delete the specified interface group from the Cohesity Cluster.
#
GET
/public/nlmLocks
List the NLM locks that match the filter criteria specified using parameters.
#
DELETE
/public/nlmLocks
Clear NLM locks that match the filter criteria specified using parameters.
#
POST
/public/packages/url
Download a package to the Cluster by providing a URL where the package is hosted.
#
POST
/public/physicalAgents/upgrade
Initiate a request to upgrade Cohesity agents on one or more Physical Servers registered on the Cohesity Cluster.
#
GET
/public/principals/protectionSources
Returns the Protection Sources objects and View names that the principals have permissions to access.
#
PUT
/public/principals/protectionSources
Set the Protection Sources and Views that the specified principal has permissions to access.
#
GET
/public/principals/searchPrincipals
List the user and group principals that match the filter criteria specified using parameters.
#
POST
/public/protectionJobState/{id}
Pause future Runs or resume future Runs of the specified Protection Job.
#
POST
/public/protectionJobs/states
Perform an action like pause, resume, activate, deactivate on all the specified Protection Jobs.
#
PUT
/public/protectionRuns
Update how long Protection Job Runs and their snapshots are retained on the Cohesity Cluster.
#
GET
/public/protectionRuns/errors
List Protection Job Run Errors filtered by the specified parameters.
#
GET
/public/protectionSources
Returns the registered Protection Sources and their Object subtrees.
#
GET
/public/protectionSources/applicationServers
Returns the registered Application Servers and their Object subtrees.
#
PUT
/public/protectionSources/applicationServers
Modifies the registration parameters of Application Servers in a Protection Source.
#
POST
/public/protectionSources/applicationServers
Register a Protection Source as running one or more Application Servers like Microsoft SQL servers or Microsoft Exchange servers.
#
DELETE
/public/protectionSources/applicationServers/{id}
Unregister Application Servers like Microsoft SQL servers or Microsoft Exchange servers running on a Protection Source.
#
POST
/public/protectionSources/diagnostics/{id}
Collect diagnostics of the protection source for a host type.
#
GET
/public/protectionSources/protectedObjects
Returns the list of protected Objects in a registered Protection Source.
#
POST
/public/protectionSources/refresh/{id}
Refresh the Object hierarchy of the Protection Sources tree.
#
GET
/public/protectionSources/rootNodes
Returns the top level (root) Protection Sources with registration information.
#
GET
/public/protectionSources/sqlAagHostsAndDatabases
Returns the registered Protection Sources and their Object subtrees.
#
PATCH
/public/protectionSources/{id}
Update a previously registered Protection Source with new details.
#
GET
/public/remoteClusters
List the remote Cohesity Clusters that are registered on this local Cohesity Cluster that match the filter criteria specified using parameters.
#
GET
/public/remoteClusters/{id}
List details about a single remote Cluster registered on this local Cluster.
#
PUT
/public/remoteVaults/encryptionKeys/{id}
Upload the encryption keys required to restore data from a remote Vault. (CloudRetrieve)
#
GET
/public/remoteVaults/restoreTasks
List the remote Vault restore tasks that have completed or are running on this Cohesity Cluster. (CloudRetrieve)
#
GET
/public/remoteVaults/searchJobResults
List details about the Job Runs of Protection Jobs found by a single search of a remote Vault. (CloudRetrieve)
#
DELETE
/public/remoteVaults/searchJobs
Stop a search of a remote Vault (External Target). (CloudRetrieve)
#
GET
/public/remoteVaults/searchJobs/{id}
List details about a single search Job of a remote Vault. (CloudRetrieve)
#
GET
/public/reports/dataTransferFromVaults
Get summary statistics about transferring data from Vaults (External Targets) to this Cohesity Cluster.
#
GET
/public/reports/dataTransferToVaults
Get summary statistics about transferring data from the Cohesity Cluster to Vaults (External Targets).
#
GET
/public/reports/protectedObjectsTrends
Get protected objects trends grouped by days/weeks/months.
#
GET
/public/reports/protectionSourcesJobRuns
Get protection details about the specified list of leaf Protection Source Objects (such as a VMs).
#
GET
/public/reports/protectionSourcesJobsSummary
Get Job Run (Snapshot) summary statistics about the leaf Protection Sources Objects that match the specified filter criteria.
#
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.
#
GET
/public/restore/adObjects
Searches for AD Objects in both Production and Snapshot AD from given search base dn and offset.
#
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.
#
POST
/public/restore/applicationsClone
Create a Restore Task for cloning Applications like SQL Databases.
#
POST
/public/restore/applicationsClone/refresh
Create a Clone Refresh Task to refresh the clone with the new data.
#
POST
/public/restore/applicationsRecover
Create a Restore Task for recovering Applications like SQL Databases.
#
POST
/public/restore/downloadFilesAndFolders
Create a Download Task for downloading files and folders.
#
GET
/public/restore/files
Search for files and folders to recover that match the specified search and filter criteria on the Cohesity Cluster.
#
GET
/public/restore/files/fstats
Get the fstat information about file provided using query parameters.
#
GET
/public/restore/files/snapshotsInformation
Get the information about snapshots that contain the specified file or folder. In addition, information about the file or folder is provided.
#
GET
/public/restore/objects
Find backup objects that match the specified search and filter criteria on the Cohesity Cluster.
#
GET
/public/restore/office365/outlook/emails
Returns the Outlook emails and folders containing emails.
#
GET
/public/restore/office365/sharepoint/documents
Returns the Sharepoint Site's files and folders.
#
POST
/public/restore/recover
Create a Restore Task for recovering VMs or instantly mounting volumes.
#
Documentation
📖
Documentation
https://developer.cohesity.com/apidocs/versions/
📖
APIReference
https://developers.cohesity.com/page/api-reference
📖
GettingStarted
https://developers.cohesity.com/docs/getting-started
Specifications
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cohesity/refs/heads/main/openapi/cohesity-cluster-v1-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cohesity/refs/heads/main/openapi/_original/cohesity-cluster-v1-openapi-original.yml