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.
Cohesity DataProtect REST API is one of 4 APIs that Cohesity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Backup, DataProtect, Disaster Recovery, and Per-Cluster. The published artifact set on APIs.io includes API documentation, an API reference, a getting-started guide, and an OpenAPI specification.
This API exposes 379 operations across 263 paths, organized into 56 resource areas, and defines 1120 schemas. It is described by OpenAPI 2.0, at version 1.0.
Requests are made against the base URL https://{cluster-vip}/irisservices/api/v1/public.
379 operations
263 paths
1120 schemas
42 DELETE181 GET3 PATCH81 POST72 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 379
Across 263 paths, the API surfaces 379 operations — 42 DELETE, 181 GET, 3 PATCH, 81 POST, 72 PUT. They span 56 resource areas, including AccessTokens, ActiveDirectory, Alerts, Analytics, AntivirusServiceGroup, AppInstance, App, Audit, and 48 more. Each is listed below with its method, path, parameters, and response codes.
AccessTokens 1
POST
/public/accessTokens
Generate an Access Token.
ActiveDirectory 13
GET
/public/activeDirectory
Lists the Active Directories that the Cohesity Cluster has joined.
POST
/public/activeDirectory
Join the Cohesity Cluster to the specified Active Directory.
DELETE
/public/activeDirectory
Deletes the join with the Active Directory.
GET
/public/activeDirectory/centrifyZones
Fetches the list centrify zones of an active directory domain.
GET
/public/activeDirectory/domainControllers
List the domain controllers for a 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 Cohesity privileges.
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.
PUT
/public/activeDirectory/{name}/preferredDomainControllers
Updates the preferred domain controllers of an Active Directory
Alerts 12
GET
/public/alertCategories
Get alert categories in the Cohesity cluster.
GET
/public/alertNotificationRules
Gets all alert notification rules.
PUT
/public/alertNotificationRules
Updates an existing alert notification rule.
POST
/public/alertNotificationRules
Creates a new alert notification rule.
DELETE
/public/alertNotificationRules/{ruleId}
Deletes an alert notification rule.
GET
/public/alertResolutions
List the Alert Resolutions on the Cohesity Cluster.
POST
/public/alertResolutions
Create an Alert Resolution.
GET
/public/alertResolutions/{id}
List details about a single Alert Resolution.
PUT
/public/alertResolutions/{id}
Apply an existing Alert Resolution to additional Alerts.
GET
/public/alertTypes
Get registered alerts in the Cohesity cluster.
GET
/public/alerts
List the Alerts on the Cohesity Cluster.
GET
/public/alerts/{id}
List details about a single Alert.
Analytics 28
POST
/public/analytics/analyzeJar
Analyze the uploaded jar.
GET
/public/analytics/apps
List Applications filtered by the specified parameters.
POST
/public/analytics/apps
Create an Application.
GET
/public/analytics/apps/{id}
List details about a single Application.
PUT
/public/analytics/apps/{id}
Update an Application.
DELETE
/public/analytics/apps/{id}
Delete an Application.
PUT
/public/analytics/cancelAppInstanceRun/{id}
Cancel a specific map reduce instance run.
GET
/public/analytics/mappers
List Mappers filtered by the specified parameters.
POST
/public/analytics/mappers
Create a Mapper.
GET
/public/analytics/mappers/{id}
List details about a single Mapper.
PUT
/public/analytics/mappers/{id}
Update a Mapper.
DELETE
/public/analytics/mappers/{id}
Delete a Mapper.
DELETE
/public/analytics/mrAppRun/{id}
Delete a Map-Reduce Application Instance Run.
GET
/public/analytics/mrAppRuns
List map reduce application runs filtered by the specified parameters.
GET
/public/analytics/mrBaseJar
Downloads the map reduce base jar.
GET
/public/analytics/mrFileFormats
Used to retrieve supported output file formats from a map reduce instance.
GET
/public/analytics/mrOutputfiles
Download map reduce base instance run output files from Yoda.
GET
/public/analytics/reducers
List Reducers filtered by the specified parameters.
POST
/public/analytics/reducers
Create a Reducer.
GET
/public/analytics/reducers/{id}
List details about a single Reducer.
PUT
/public/analytics/reducers/{id}
Update a Reducer.
DELETE
/public/analytics/reducers/{id}
Delete a Reducer.
PUT
/public/analytics/runAppInstance
Run a map-reduce application instance.
GET
/public/analytics/supportedPatterns
Used to retrieve supported patterns available for search in an application.
PUT
/public/analytics/supportedPatterns
Used to save user patterns for search in an application.
POST
/public/analytics/uploadJar
Upload a jar to pre-specified Yoda internal view.
DELETE
/public/analytics/uploadJar
Delete the uploaded jar from temporary location.
GET
/public/analytics/uploadJarPath
Get details about the mounted path to upload Jars.
AntivirusServiceGroup 9
GET
/public/antivirusGroups
Lists the antivirus service groups.
PUT
/public/antivirusGroups
Update an antivirus service group.
POST
/public/antivirusGroups
Create an Antivirus service group.
PUT
/public/antivirusGroups/states
Change the state of an antivirus service group.
DELETE
/public/antivirusGroups/{id}
Delete an antivirus service group corresponding to the specified antivirus service group Id.
GET
/public/icapConnectionStatus
Check the Icap server connection status.
GET
/public/infectedFiles
Lists the infected files.
PUT
/public/infectedFiles
Update the list of infected files.
DELETE
/public/infectedFiles
Delete the list of infected files.
AppInstance 4
PUT
/public/appInstanceSettings/{appInstanceId}
Updates app instance settings.
GET
/public/appInstances
Lists the app instances.
POST
/public/appInstances
Starts the application instance launch on the cluster.
PUT
/public/appInstances/{appInstanceId}/states
Updates app instance state.
App 4
GET
/public/apps
Lists the apps.
POST
/public/apps
Upload and install an app from image.
POST
/public/apps/{appUid}/versions/{version}
Starts the application installation on the cluster.
DELETE
/public/apps/{appUid}/versions/{version}
Starts the application uninstall from the cluster.
Audit 3
GET
/public/auditLogs/actions
Return list of audit log actions.
GET
/public/auditLogs/categories
Return list of audit log categories.
GET
/public/auditLogs/cluster
Lists the cluster audit logs on the Cohesity Cluster that match the filter criteria specified using parameters.
Banner 2
GET
/public/banners
List the banner for a persona.
PUT
/public/banners
Update an existing banner on the Cohesity Cluster.
Cluster 6
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/cluster
List details about this Cohesity Cluster.
PUT
/public/cluster
Update the configuration of this Cohesity Cluster.
GET
/public/cluster/appSettings
Gets the app settings for the cluster.
PUT
/public/cluster/appSettings
Update the app settings of the cluster.
GET
/public/cluster/status
Get the status of a Cohesity Cluster.
Certificates 5
GET
/public/certificates/global
List the certificates generated and deployed on hosts.
POST
/public/certificates/global
Generate and deploy certificate for a single or multiple hosts.
GET
/public/certificates/webServer
Get the Server Certificate configured on the Cluster.
PUT
/public/certificates/webServer
Update the Web Server Certificate on the Cluster.
DELETE
/public/certificates/webServer
Delete the SSL Certificate in the Cluster.
Clusters 18
GET
/public/cluster/backgroundActivitySchedule
Get the Apollo Throttling schedule.
PUT
/public/cluster/backgroundActivitySchedule
Update the Apollo Throttling schedule.
GET
/public/cluster/keys
List the Public Keys for the cluster.
DELETE
/public/clusters
Destroy a Cohesity Cluster.
POST
/public/clusters/cloudEdition
Create a new Cloud Edition Cohesity Cluster.
POST
/public/clusters/cloudEdition/nodes
Expand a Cloud Edition Cohesity Cluster.
GET
/public/clusters/creationProgress
Check the progress of the creation of a new Cohesity Cluster.
GET
/public/clusters/ioPreferentialTier
Return the IO preferential tiers of the cluster.
PUT
/public/clusters/ioPreferentialTier
Update the IO preferential tiers and return the updated IO preferential tiers of the cluster.
DELETE
/public/clusters/nodes/{id}
Remove a Node from a Cohesity Cluster.
POST
/public/clusters/physicalEdition
Create a new Physical Edition Cohesity Cluster.
POST
/public/clusters/physicalEdition/nodes
Expand a Physical Edition Cohesity Cluster.
GET
/public/clusters/services/states
List the states of the services on the Cluster.
POST
/public/clusters/services/states
Change the state of one or more services on a Cohesity Cluster.
PUT
/public/clusters/software
Upgrade a Cohesity Cluster.
POST
/public/clusters/virtualEdition
Create a new Virtual Edition Cohesity Cluster.
GET
/public/externalClientSubnets
List the external Client Subnets for the cluster.
PUT
/public/externalClientSubnets
Update the external Client Subnet of the Cluster.
ClusterPartitions 2
GET
/public/clusterPartitions
List Cluster Partitions filtered by the specified parameters.
GET
/public/clusterPartitions/{id}
List details about a single Cluster Partition.
Dashboard 1
GET
/public/dashboard
Returns the dashboard that match the filter criteria specified using parameters.
Nodes 5
GET
/public/freeNodes
List the free Nodes present on a network.
GET
/public/node/status
Sends a request to a Node to get the status of that node.
GET
/public/nodes
List Nodes of the cluster.
PUT
/public/nodes/software
Upgrade the software on a Node.
GET
/public/nodes/{id}
List details about a single node.
Groups 4
GET
/public/groups
List the groups 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 Directory.
POST
/public/groups
Create or add a new group to the Cohesity Cluster.
DELETE
/public/groups
Delete one or more groups on the Cohesity Cluster.
Idps 6
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.
GET
/public/idps
List the IdPs configured on the Cluster.
POST
/public/idps
Create an IdP configuration.
GET
/public/idps/login
Login to Cohesity Cluster using an IdP.
PUT
/public/idps/{id}
Update an IdP configuration.
DELETE
/public/idps/{id}
Delete one IdP configuration.
Interface 2
GET
/public/interface
Show network interfaces.
PUT
/public/interface
Update an interface.
InterfaceGroup 4
GET
/public/interfaceGroups
List the interface groups for the Cohesity Cluster.
PUT
/public/interfaceGroups
Update an interface group on the Cohesity Cluster.
POST
/public/interfaceGroups
Create an interface group on the Cohesity Cluster.
DELETE
/public/interfaceGroups/{name}
Delete the specified interface group from the Cohesity Cluster.
Ip 2
PUT
/public/ip
Configure the specfied IP settings on the Cohesity Cluster.
DELETE
/public/ip
Delete the specified IP settings on the Cohesity Cluster.
KmsConfigurationResponse 1
GET
/public/kmsConfig
List KMS configurations in the cluster.
KmsUpdateRequestParameters 1
PUT
/public/kmsConfig
Update KMS configurations in the cluster.
KmsConfiguration 1
POST
/public/kmsConfig
Create a KMS config.
LdapProvider 5
GET
/public/ldapProvider
Lists the LDAP providers.
PUT
/public/ldapProvider
Update an LDAP provider.
POST
/public/ldapProvider
Create a LDAP provider.
DELETE
/public/ldapProvider/{id}
Delete an LDAP provider.
GET
/public/ldapProvider/{id}/status
Get the connection status of an LDAP provider.
License 1
GET
/public/licenseUsage
Get the current license usage of a Cohesity Cluster.
Monitoring 3
GET
/public/monitoring/jobRunInfo
List info related to a job run.
GET
/public/monitoring/jobs
List runs of all the jobs.
GET
/public/monitoring/objectDetails
List details of objects in a job run.
Network 6
POST
/public/network/bonds
Create a new network bond.
DELETE
/public/network/bonds/{name}
Delete a network bond.
GET
/public/network/hosts
Get the current entries in the hosts file on the Cluster.
PUT
/public/network/hosts
Edit entries in the Cluster's /etc/hosts file.
POST
/public/network/hosts
Add new entries to the /etc/hosts file.
DELETE
/public/network/hosts
Remove entries from the /etc/hosts file.
Views 33
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.
GET
/public/qosPolicies
Fetches QoS Policies of a view.
GET
/public/shares
List shares filtered by name.
GET
/public/smbConnections
Fetches Smb Connection Status of a view.
PUT
/public/viewAliases
Update a View Alias. A View Alias allows a directory inside the view to be mounted without specifying the entire path.
POST
/public/viewAliases
Create a View Alias. A View Alias allows a directory inside the view to be mounted without specifying the entire path.
DELETE
/public/viewAliases/{name}
Delete a View Alias.
POST
/public/viewAliases/{name}/activate
Activates the view aliases of a view from it's source view.
GET
/public/viewDirectoryQuotas
Gets directory quota info for a view. Returns error if op fails.
PUT
/public/viewDirectoryQuotas
Updates a directory quota policy for a view. Returns error if op fails.
GET
/public/viewUserQuotas
Get the quota policies, usage and summary for a view for all its users. It can also fetch the quota policies, usage and summary for a user in all his views.
PUT
/public/viewUserQuotas
Update a new quota policy for a user in a view.
POST
/public/viewUserQuotas
Create a new quota policy for a user in a view.
DELETE
/public/viewUserQuotas
Delete the quota policy overrides for users in a view.
PUT
/public/viewUserQuotasSettings
Update the user quota settings in a view.
GET
/public/views
List Views filtered by some parameters.
PUT
/public/views
Update a View.
POST
/public/views
Create a View.
POST
/public/views/clone
Clone a View.
POST
/public/views/cloneDirectory
Clone a directory of a view.
GET
/public/views/id/{id}
List details about a single View.
DELETE
/public/views/id/{id}
Delete a View.
GET
/public/views/id/{id}/fileLocks
Fetches the lock status of a file in a view.
POST
/public/views/id/{id}/fileLocks
Lock a file in a view and optionally update its expiry timestamp.
POST
/public/views/overwrite
Overwrites a Target view with contents of a Source view.
POST
/public/views/rename/id/{id}
Rename a View.
POST
/public/views/rename/{name}
Rename a View.
GET
/public/views/{name}
List details about a single View.
PUT
/public/views/{name}
Update a View.
DELETE
/public/views/{name}
Delete a View.
GET
/public/views/{name}/fileLocks
Fetches the lock status of a file in a view.
POST
/public/views/{name}/fileLocks
Lock a file in a view and optionally update its expiry timestamp.
Packages 2
GET
/public/packages
List all currently installed packages on a Cohesity Cluster.
POST
/public/packages/url
Download a package to the Cluster by providing a URL where the package is hosted.
ProtectionSources 22
GET
/public/physicalAgents/download
Download the physical agent for a host type.
POST
/public/physicalAgents/upgrade
Initiate a request to upgrade Cohesity agents on one or more Physical Servers registered on the Cohesity Cluster.
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.
GET
/public/protectionSources/datastores
Returns the datastore information in VMware environment.
POST
/public/protectionSources/diagnostics/{id}
Collect diagnostics of the protection source for a host type.
GET
/public/protectionSources/downloadCftFile
Download the CFT.
GET
/public/protectionSources/exchangeDagHosts
Returns information about all the exchange hosts that belong to an Exchange DAG.
GET
/public/protectionSources/objects
List details about Protection Source objects.
GET
/public/protectionSources/objects/{id}
Get details about a single Protection Source Object.
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.
POST
/public/protectionSources/register
Register a Protection Source.
GET
/public/protectionSources/registrationInfo
Returns the registration and protection information of the registered Protection Sources.
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.
GET
/public/protectionSources/virtualMachines
Returns the Virtual Machines in a vCenter Server.
DELETE
/public/protectionSources/{id}
Unregister a previously registered Protection Source.
PATCH
/public/protectionSources/{id}
Update a previously registered Protection Source with new details.
CustomReporting 1
GET
/public/postgres
List the postgres database running nodes on the cohesity cluster.
Principals 17
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.
GET
/public/sessionUser
Get the information of the logged in user.
GET
/public/users
List the users on the Cohesity Cluster that match the filter criteria specified using parameters.
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.
POST
/public/users
Create or add a new user to the Cohesity Cluster.
DELETE
/public/users
Delete one or more users on the Cohesity Cluster.
GET
/public/users/privileges
List the privileges of the session user.
POST
/public/users/s3SecretKey
Reset the S3 secret access key for the specified user on the Cohesity Cluster.
GET
/public/users/{sid}/apiKeys
Fetch API keys for user.
POST
/public/users/{sid}/apiKeys
Create an API key for user.
GET
/public/users/{sid}/apiKeys/{id}
Fetch an API key for user by its id.
PUT
/public/users/{sid}/apiKeys/{id}
Update an API key.
DELETE
/public/users/{sid}/apiKeys/{id}
Delete an API key for user.
POST
/public/users/{sid}/apiKeys/{id}/rotate
Fetch an API key for user by its id.
GET
/public/usersApiKeys
Fetch API keys across all users.
Privileges 1
GET
/public/privileges
List the privileges defined on the Cohesity Cluster.
ProtectionJobs 9
POST
/public/protectionJobState/{id}
Pause future Runs or resume future Runs of the specified Protection Job.
GET
/public/protectionJobs
List Protections Jobs filtered by the specified parameters.
POST
/public/protectionJobs
Create a Protection Job.
POST
/public/protectionJobs/run/{id}
Immediately execute a single Protection Job Run.
POST
/public/protectionJobs/states
Perform an action like pause, resume, activate, deactivate on all the specified Protection Jobs.
GET
/public/protectionJobs/{id}
List details about single Protection Job.
PUT
/public/protectionJobs/{id}
Update a Protection Job.
DELETE
/public/protectionJobs/{id}
Delete a Protection Job.
GET
/public/protectionJobs/{id}/auditTrail
List a protection job audit.
ProtectionObjects 4
PUT
/public/protectionObjects
Update a Protected Object.
POST
/public/protectionObjects
Protect an Object.
DELETE
/public/protectionObjects
Unprotect a Protected Object.
GET
/public/protectionObjects/summary
Protect an Object.
ProtectionPolicies 6
GET
/public/protectionPolicies
List Protection Policies filtered by some parameters.
POST
/public/protectionPolicies
Create a Protection Policy.
GET
/public/protectionPolicies/{id}
List details about a single Protection Policy.
PUT
/public/protectionPolicies/{id}
Update a Protection Policy.
DELETE
/public/protectionPolicies/{id}
Delete a Protection Policy.
GET
/public/protectionPolicySummary
List Protection Policy Summary.
ProtectionRuns 4
GET
/public/protectionRuns
List Protection Job Runs filtered by the specified parameters.
PUT
/public/protectionRuns
Update how long Protection Job Runs and their snapshots are retained on the Cohesity Cluster.
POST
/public/protectionRuns/cancel/{id}
Cancel a Protection Job run.
GET
/public/protectionRuns/errors
List Protection Job Run Errors filtered by the specified parameters.
RemoteCluster 6
GET
/public/remoteClusters
List the remote Cohesity Clusters that are registered on this local Cohesity Cluster that match the filter criteria specified using parameters.
POST
/public/remoteClusters
Register a remote Cluster on this local Cluster for replication.
GET
/public/remoteClusters/{id}
List details about a single remote Cluster registered on this local Cluster.
PUT
/public/remoteClusters/{id}
Update the connection settings of the registered remote Cluster.
DELETE
/public/remoteClusters/{id}
Delete a remote Cluster registration connection.
GET
/public/replicationEncryptionKey
Get the encryption key on this Cluster.
RemoteRestore 8
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)
POST
/public/remoteVaults/restoreTasks
Create a remote Vault restore task. (CloudRetrieve)
GET
/public/remoteVaults/searchJobResults
List details about the Job Runs of Protection Jobs found by a single search of a remote Vault. (CloudRetrieve)
GET
/public/remoteVaults/searchJobs
List all the searches of remote Vaults. (CloudRetrieve)
POST
/public/remoteVaults/searchJobs
Create a 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)
Reports 7
GET
/public/reports/agents
Get the list of all the installed agents which includes the health status and upgradability of the agent.
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/gdpr
Get gdpr report related information.
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.
RestoreTasks 30
GET
/public/restore/adDomainRootTopology
Gets Root Topology for an AD Domain.
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.
GET
/public/restore/adObjects/searchResults
Search for AD objects to recover that match the specified search and filter criterias provided in the request.
GET
/public/restore/adObjects/status
Returns the Restore status of the AD objects which were restored from the snapshot AD to production AD as part of the restore task id specified in the parameters.
POST
/public/restore/applicationsClone
Create a Restore Task for cloning Applications like SQL Databases.
POST
/public/restore/applicationsRecover
Create a Restore Task for recovering Applications like SQL Databases.
POST
/public/restore/clone
Create a Restore Task for cloning VMs or a View.
DELETE
/public/restore/clone/{id}
Destroy a clone task with specified id.
POST
/public/restore/deploy
Create a Restore Task for deploying VMs or a View on cloud.
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.
POST
/public/restore/files
Create a Restore Task for recovering files and folders.
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/onedrive/documents
Returns the OneDrive files and folders.
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/pointsForTimeRange
List Restore Points in a give time range.
PUT
/public/restore/recover
Updates an existing restore task with additional params which are needed for features like Hot-Standby.
POST
/public/restore/recover
Create a Restore Task for recovering VMs or instantly mounting volumes.
GET
/public/restore/tasks
List the Restore Tasks filtered by the specified parameters.
PUT
/public/restore/tasks/cancel/{id}
Cancel a recover or clone task with specified id.
GET
/public/restore/tasks/{id}
List details about a single Restore Task.
GET
/public/restore/virtualDiskInformation
Fetches information of virtual disk.
GET
/public/restore/vms/directoryList
Get the directory list based on the given directory name and other query parameters.
GET
/public/restore/vms/volumesInformation
Get information about the logical volumes found in a VM.
GET
/public/virtualDatacenters/{id}/storageProfiles
Fetches information of virtual disk.
CloneRefreshTasks 1
POST
/public/restore/applicationsClone/refresh
Create a Clone Refresh Task to refresh the clone with the new data.
Roles 4
GET
/public/roles
List the roles defined on the Cohesity Cluster.
POST
/public/roles
Create a new custom role.
DELETE
/public/roles
Delete one or more custom Roles.
PUT
/public/roles/{name}
Update a user-defined custom role.
Routes 3
GET
/public/routes
List the Static Routes for the Cohesity Cluster.
POST
/public/routes
Create a Static Route on the Cohesity Cluster.
DELETE
/public/routes
Delete the specified Static Route from the Cohesity Cluster.
Scheduler 4
GET
/public/scheduler
List the email report schedule jobs that are scheduled to run.
PUT
/public/scheduler
Update an existing email report schedule job.
POST
/public/scheduler
Create an email report scheduler job.
DELETE
/public/scheduler
Delete one or more email report schedule jobs.
Search 2
GET
/public/search/protectionRuns
Returns the information of latest snapshot of a particular object across all snapshot target locations.
GET
/public/search/protectionSources
Performs search on all the objects which are registered to a cluster.
Notifications 2
GET
/public/sessionUser/notifications
List the notification of the session user.
PATCH
/public/sessionUser/notifications
Perform operations on the notification of the session user.
Preferences 3
GET
/public/sessionUser/preferences
List the preferences of the session user.
PUT
/public/sessionUser/preferences
Update the preferences of the session user
PATCH
/public/sessionUser/preferences
Update specific preferences of the session user
SMBFileOpens 2
GET
/public/smbFileOpens
List the active SMB file opens that match the filter criteria specified using parameters.
POST
/public/smbFileOpens
Closes an active SMB file open.
Statistics 6
GET
/public/statistics/entities
Lists the entities for the specified schema.
GET
/public/statistics/entitiesSchema
List the entity schemas filtered by the specified parameters.
GET
/public/statistics/entitiesSchema/{schemaName}
Get the entity schema for the specified schema.
GET
/public/statistics/timeSeriesSchema
Gets the Apollo schema information for an entity to list a series of data points.
GET
/public/statistics/timeSeriesStats
List a series of data points for an entity of a metric in a schema, during the specified time period.
GET
/public/tasks/status
Gets the progress and status of tasks.
Stats 15
GET
/public/stats/alerts
Compute the statistics on the active Alerts generated on the cluster.
GET
/public/stats/consumers
Gets the statistics of consumers.
GET
/public/stats/files
Compute the file distribution statistics on a given entity like cluster or storage domain.
GET
/public/stats/protectionRuns
Compute the statistics on the Protection Runs for the cluster.
GET
/public/stats/protectionRuns/lastRun
Compute stats on last Protection Run for every job.
GET
/public/stats/protectionSummary
Computes the protected objects summary on the cluster.
GET
/public/stats/restores
Compute the statistics on the Restore tasks on the cluster.
GET
/public/stats/storage
Computes the storage stats on the cluster.
GET
/public/stats/tenants
Gets the statistics of organizations (tenant).
GET
/public/stats/vaults
Compute the statistics on vaults.
GET
/public/stats/vaults/providers
Compute the size and count of entities on vaults.
GET
/public/stats/vaults/runs
Compute the statistics on protection runs to or from a vault.
GET
/public/stats/viewBoxes
Gets the statistics of view boxes (storage domain).
GET
/public/stats/views
Compute the statistics on Views.
GET
/public/stats/views/protocols
Compute the protocol statistics on Views.
Tags 2
PUT
/public/tags/apply
Apply Tags on existing objects in the Cohesity Cluster.
PUT
/public/tags/remove
Remove Tags on existing objects in the Cohesity Cluster.
Tenant 17
GET
/public/tenants
List the tenants on the cohesity cluster filtered by tenant ID prefixed to list tenants for the respective tenant admin.
PUT
/public/tenants
Update an existing tenant on the Cohesity Cluster.
POST
/public/tenants
Create/add a new tenant to the Cohesity Cluster.
DELETE
/public/tenants
Delete an existing tenant on the Cohesity Cluster.
PUT
/public/tenants/activeDirectory
Update Active Directory for an existing tenant on the Cohesity Cluster.
PUT
/public/tenants/entity
Update entity permission for an existing tenant on the Cohesity Cluster.
PUT
/public/tenants/groups
Update existing groups to an existing tenant on the Cohesity Cluster.
PUT
/public/tenants/ldapProvider
Update Ldap Providers for an existing tenant on the Cohesity Cluster.
PUT
/public/tenants/policy
Update protection policy permission for an existing tenant on the Cohesity Cluster.
PUT
/public/tenants/protectionJob
Update protection job for an existing tenant on the Cohesity Cluster.
GET
/public/tenants/proxies
List proxies for tenant which are running within tenant's environment.
GET
/public/tenants/proxy/config
Get proxy config for tenant.
GET
/public/tenants/proxy/image
Downloads the tenants proxy.
PUT
/public/tenants/users
Update existing users to an existing tenant on the Cohesity Cluster.
PUT
/public/tenants/view
Update views permission for an existing tenant on the Cohesity Cluster.
PUT
/public/tenants/viewBox
Update view box for an existing tenant on the Cohesity Cluster.
PUT
/public/tenants/vlan
Update vlan for an existing tenant on the Cohesity Cluster.
Vaults 9
GET
/public/vaults
List the Vaults (External Targets) registered on the Cohesity Cluster filtered by the specified parameters.
POST
/public/vaults
Create a new Vault (External Target).
GET
/public/vaults/archiveMediaInfo
List the media information for the specified archive service.
GET
/public/vaults/bandwidthSettings
List the upload and download bandwidth limit and bandwidth overrides settings.
PUT
/public/vaults/bandwidthSettings
Updates bandwidth limits.
GET
/public/vaults/encryptionKey/{id}
Get encryption information for a Vault (External Target). A Vault is equivalent to an External Target in the Cohesity Dashboard.
GET
/public/vaults/{id}
List details about a single Vault (External Target).
PUT
/public/vaults/{id}
Update a Vault (External Target).
DELETE
/public/vaults/{id}
Delete a Vault (External Target).
ViewBoxes 5
GET
/public/viewBoxes
List Domains (View Boxes) filtered by the specified parameters.
POST
/public/viewBoxes
Create a Domain (View Box).
GET
/public/viewBoxes/{id}
List details about a single Domain (View Box).
PUT
/public/viewBoxes/{id}
Update a Domain (View Box).
DELETE
/public/viewBoxes/{id}
Delete a Domain (View Box).
Vlan 5
GET
/public/vlans
List the VLANs for the Cohesity Cluster.
POST
/public/vlans
Creates a VLAN of the Cohesity Cluster.
GET
/public/vlans/{id}
List the details about a single VLAN.
PUT
/public/vlans/{id}
Creates or updates a VLAN of the Cohesity Cluster.
DELETE
/public/vlans/{id}
Remove the specified VLAN from the Cohesity Cluster.
Schemas 1120
The contract defines 1120 schemas that model the data the API accepts and returns. The most detailed are PerformRestoreTaskStateProto (70 properties), BackupJobProto (66 properties), ProtectionJob (56 properties), Cluster (55 properties). Each schema is shown below with its type and property counts.
ACLProto
object
Protobuf that describes the access control list (ACL) permissions for a bucket or for an object.
5 properties
ACLProto_Grant
object
2 properties
ADAttributeRestoreParam
object
5 properties
ADGuidPair
object
2 properties
ADObject
object
Represents the details about an AD object.
8 properties
ADObjectRestoreParam
object
5 properties
ADObjectRestoreStatus
object
6 properties
ADObjectRestoreStatus_ADAttributeRestoreStatus
object
2 properties
ADRestoreStatus
object
Represents AD restore status for object/attribute recovery. Each ADRestoreStatus entry will contain objectinfo: information about the object getting restored a…
2 properties
ADUpdateRestoreTaskOptions
object
3 properties
AWSFleetParams
object
5 properties
AWSFleetParams_NetworkParams
object
3 properties
AWSFleetParams_NetworkParamsMapEntry
object
2 properties
AWSFleetParams_Tag
object
2 properties
AWSSnapshotManagerParams
object
3 properties
AagAndDatabases
object
Specifies an AAG and the database members of the AAG.
2 properties
AccessToken
object
Specifies an Access Token that provides permissions for a client to access the Cohesity REST API available from a Cohesity Cluster.
3 properties
AccessTokenCredential
object
Specifies the Cohesity credentials required for generating an access token.
3 properties
2 required
AcropolisProtectionSource
object
Specifies a Protection Source in Acropolis environment.
7 properties
AcropolisRestoreParameters
object
This field defines the Acropolis specific params for restore tasks of type kRecoverVMs.
6 properties
ActivateViewAliasesResult
object
Specifies the information of activated alias views created for a view.
1 property
ActiveAlertsStats
object
Specifies the active alert statistics details.
22 properties
ActiveDirectoryEntry
object
Specifies the join settings for a Microsoft Active Directory domain.
16 properties
ActiveDirectoryPrincipal
object
Specifies information about a single principal in an Active Directory.
5 properties
ActiveDirectoryPrincipalsAddParameters
object
Specifies the settings for adding new users and groups for Active Directory principals. These users and groups are added to the Cohesity Cluster. You cannot cr…
6 properties
AdAttribute
object
Represnts the information about the AD attribute of the object. It also contains information regarding whether it is system attribute and whether the attribute…
6 properties
AdDomain
object
Specifies information about an AD Domain.
6 properties
AdDomainController
object
Specifies information about an AD domain controller.
7 properties
AdDomainIdentity
object
AD domain identity information.
4 properties
AdGuidPair
object
AdGuidPair is the AD object guid string pair.
2 properties
AdObjectAttributeParameters
object
AdObjectAttributeParameters are AD attribute recovery parameters for one or more AD objects
4 properties
AdObjectMetaData
object
Specifies details about the AD objects.
7 properties
AdObjectRestoreInformation
object
Represents the details about the restore of the AD object.
5 properties
AdObjectRestoreParameters
object
AdObjectRestoreParameters are the parameters to restore AD objects from recycle bin or from a mounted AD snapshot database.
5 properties
AdObjectsRestoreStatus
object
Represents the details about the status of restore of the AD objects. It also has details about the number of objects whose restore is successfull, failure or…
3 properties
AdProtectionSource
object
Specifies an object representing an AD entity.
6 properties
AdRestoreOptions
object
AdRestoreOptions are the AD specific options for the restore task being updated
3 properties
AdRestoreParameters
object
Specifies the parameters specific to Application domain controller.
4 properties
AdRootTopologyObject
object
Represents a node in AD Topology tree.
8 properties
AddedActiveDirectoryPrincipal
object
Specifies a group or user added to the Cohesity Cluster for an Active Directory principal.
9 properties
AddedIdpPrincipal
object
Specifies a group or user added to the Cohesity Cluster for an Idp principal.
8 properties
AdditionalConnectorParams
object
Message that encapsulates the additional connector params to establish a connection with a particular environment.
2 properties
AdditionalOracleDBParams
object
2 properties
AgentDeploymentStatusResponse
object
Specifies the overview of the agent deployment status.
8 properties
AgentInformation
object
Specifies information about the Agent software running on the server or the Virtual Machine.
13 properties
AggregatedSubtreeInfo
object
Aggregated information about a node subtree.
3 properties
Alert
object
Specifies information about an Alert such as the type, id assigned by the Cohesity Cluster, number of duplicates, severity, etc.
19 properties
AlertCategoryName
object
AlertCategoryName returns alert category and its public facing string.
2 properties
AlertDocument
object
Specifies documentation about the Alert such as name, description, cause and how to resolve the Alert.
4 properties
AlertMetadata
object
AlertMetadata specifies metadata for a given alert type. All the alerts of a given alert type share the same metadata.
14 properties
AlertProperty
object
Specifies a key-value pair associated with an Alert.
2 properties
AlertResolution
object
Provides Resolution details and the list of Alerts resolved by a Resolution, which are specified by Alert Ids.
3 properties
AlertResolutionDetails
object
Specifies information about the Alert Resolution such as a summary, id assigned by the Cohesity Cluster, user who resolved the Alerts, etc.
5 properties
AlertResolutionInfo
object
Short description and detailed notes about the Resolution.
2 properties
AlertResolutionRequest
object
Request that provides the details of a resolution and the list of Alert Ids to be marked resolved.
2 properties
AlertingConfig
object
Specifies optional settings for alerting.
3 properties
AlertingPolicyProto
object
4 properties
AmazonCloudCredentials
object
Specifies the cloud credentials to connect to a Amazon service account. Glacier, S3, and S3-compatible clouds all use these credentials.
10 properties
AnalyseJarArg
object
API to analyse a JAR file. This JAR may contain multiple mappers/reducers. Jar will be analysed and list of all mappers/reducers found in the jar will be retur…
4 properties
AnalyseJarResult
object
3 properties
AntivirusScanConfig
object
Specifies the antivirus scan config settings for this View.
7 properties
AntivirusServiceConfig
object
Specifies configuration settings for antivirus service provider.
4 properties
1 required
AntivirusServiceConfigParams
object
Specifies the parameters for an Antivirus service provider.
2 properties
1 required
AntivirusServiceGroup
object
Specifies the configuration settings for an Antivirus service group.
5 properties
2 required
AntivirusServiceGroupParams
object
3 properties
1 required
AntivirusServiceGroupStateParams
object
Specifies the configuration settings to change the state of an Antivirus service group.
2 properties
2 required
ApiKey
object
Specifies the parameters of an API key.
10 properties
App
object
App provides information about an application.
15 properties
AppEntityBackupStatusInfo
object
Specifies the app level backup status and information.
6 properties
AppInstance
object
AppInstance provides application instance's information.
21 properties
AppInstanceIdParameter
object
1 property
1 required
AppInstanceSettings
object
AppInstanceSettings provides settings used while launching an app instance. Current settings include QoSTier to be used for the instance and views allowed to b…
7 properties
AppMetadata
object
AppMetadata provides metadata information about an application.
7 properties
AppOwnerRestoreInfo
object
3 properties
AppRunHistory
object
AppRunHistory is the struct containing the run information of the application instances. An application instance can be run only once. Each run of the applicat…
2 properties
AppendHostsParameters
object
Specifies the parameters needed for an append hosts request.
1 property
ApplicationInfo
object
Specifies the application registered on the Cohesity Cluster.
2 properties
ApplicationParameters
object
1 property
ApplicationRestoreObject
object
Specifies the Application Server to restore and parameters specific to that application.
6 properties
ApplicationRestoreParameters
object
Specifies the information regarding the application restore parameters.
4 properties
ApplicationServerInfo
object
Specifies the Information about the Exchange Server Node.
6 properties
ApplicationSpecialParameters
object
Specifies additional special settings applicable for a Protection Source of 'kSQL'/'kOracle' type in a Protection Job.
1 property
ApplicationsRestoreTaskRequest
object
Specifies the request to create a restore task for restoring Application Servers like SQL or Exchange servers hosted by a Protection Source.
8 properties
3 required
ApplicationsWrapper
object
ApplicationsWrapper is the struct to define the list of map-reduce applications.
1 property
AppsConfig
object
7 properties
ArchivalExternalTarget
object
Specifies settings about the Archival External Target (such as Tape or AWS).
3 properties
ArchivalTarget
object
Message that specifies the details about an archival target (such as cloud or tape) where backup snapshots may be archived to.
3 properties
AttributeRestoreInformation
object
Represents the details about the restore of the AD attribute.
2 properties
AttributeValue
object
Represents the information about the values of attribute of the ADObject.
2 properties
AuditLogsTile
object
Audit logs for Dashboard.
2 properties
AwsCredentials
object
Specifies the credentials to authenticate with AWS Cloud Platform.
7 properties
AwsFleetParams
object
Specifies various resources when deploying a VM to Fleet instances.
3 properties
AwsKmsConfiguration
object
8 properties
AwsKmsUpdateParams
object
4 properties
AwsParams
object
Specifies various resources when converting and deploying a VM to AWS.
6 properties
AwsProtectionSource
object
Specifies a Protection Source in AWS environment.
22 properties
AwsSnapshotManagerParameters
object
Protection Job parameters applicable to 'kAWSSnapshotManager' Environment type. Specifies additional job parameters applicable for 'kAWSSnapshotManager' Enviro…
2 properties
AzureCloudCredentials
object
Specifies the cloud credentials to connect to a Microsoft Azure service account.
3 properties
AzureCredentials
object
Specifies the credentials to authenticate with Azure Cloud Platform.
6 properties
AzureManagedDiskParams
object
Contains managed disk parameters needed to deploy to Azure using managed disk.
2 properties
AzureParams
object
Specifies various resources when converting and deploying a VM to Azure.
15 properties
AzureProtectionSource
object
Specifies a Protection Source in Azure environment.
17 properties
BackupJobPreOrPostScript
object
A message to encapsulate the pre and post scripts associated with a backup job. Pre script is executed before backup run of a job starts. Post script is execut…
4 properties
BackupJobProto
object
66 properties
BackupJobProto_BackupSource
object
1 property
BackupJobProto_DRToCloudParams
object
A Proto needed in case objects backed up by this job need to DR to cloud. "Fail over" signifies the mechanism to move the workload to cloud.
1 property
BackupJobProto_ExcludeSource
object
1 property
BackupJobProto_ExclusionTimeRange
object
A proto to specify a time range within a single day when backups are not permitted to run.
3 properties
BackupPolicyProto
object
If a backup does not get a chance to when it's due (either due to the system being busy or a conflict with another instance of the same job), the backup will s…
12 properties
BackupPolicyProto_ContinuousSchedule
object
2 properties
BackupPolicyProto_DailySchedule
object
The daily schedule encompasses weekly schedules as well. This has been done so there is only one way of specifying a schedule (backing up daily is the same as…
2 properties
BackupPolicyProto_ExclusionTimeRange
object
A proto to specify a time range within a single day when backups are not permitted to run.
3 properties
BackupPolicyProto_MonthlySchedule
object
3 properties
BackupPolicyProto_OneOffSchedule
object
1 property
BackupPolicyProto_ScheduleEnd
object
2 properties
BackupRun
object
Specifies details about the Backup task for a Job Run. A Backup task captures the original backup snapshots for each Protection Source in the Job.
15 properties
BackupScript
object
Specifies details about the pre and post backup scripts for 'kPhysical' jobs.
5 properties
BackupSourceParams
object
Message to capture any additional backup params at the source level.
6 properties
BackupSourceStats
object
Specifies statistics about a Backup task in a Protection Job Run. Specifies statistics for one backup task. One backup task is used to backup on Protection Sou…
9 properties
BackupTaskInfo
object
4 properties
BandwidthLimit
object
Specifies settings for limiting the data transfer rate between the local and remote Clusters or bandwidth limiting schedule for apollo. Only one of RateLimitBy…
4 properties
BandwidthLimitOverride
object
Specifies bandwidth limit override value to be enforced during the specified daily time period for the specified days of the week.
3 properties
Banner
object
Banner is used for storing the banner content in scribe and also for transferring it over the wire.
5 properties
BannerUpdateParameters
object
Specifies the settings used to update a new banner.
2 properties
BasicClusterInfo
object
Specifies basic information about the Cohesity Cluster.
12 properties
BasicTaskInfo
object
2 properties
BlackoutPeriod
object
Specifies a time range in a single day when new Job Runs of Protection Jobs cannot be started. For example, a Protection Job with a daily schedule could define…
4 properties
BondingOpts
object
Bonding Opts
3 properties
BulkInstallAppTaskInfo
object
Parameters for a bulk install app task.
6 properties
C2SAccessPortal
object
Specifies information required to connect to CAP to get AWS credentials. C2SAccessPortal(CAP) is AWS commercial cloud service access portal.
5 properties
CancelProtectionJobRunParam
object
2 properties
CapacityByTier
object
CapacityByTier provides the physical capacity in bytes of each storage tier.
2 properties
CassandraAdditionalParams
object
Contains additional parameters required by the agents to backup data from Cassandra.
7 properties
CassandraBackupJobParams
object
Contains any additional cassandra environment specific backup params at the job level.
2 properties
CassandraCluster
object
Specifies an Object containing information about a Cassandra cluster.
2 properties
CassandraConnectParams
object
Specifies an Object containing information about a registered cassandra source.
14 properties
CassandraKeyspace
object
Specifies an Object containing information about a Cassandra Keyspace.
3 properties
CassandraPortsInfo
object
Specifies an Object containing information on various Cassandra ports.
5 properties
CassandraProtectionSource
object
Specifies an Object representing Cassandra.
5 properties
CassandraRecoverJobParams
object
Contains any additional cassandra environment specific params for the recover job.
5 properties
CassandraSecurityInfo
object
Specifies an Object containing information on Cassandra security.
7 properties
CentrifyZone
object
Specifies the properties associated to a Centrify zone of an Active Directory domain.
3 properties
CertificateDetails
object
Specifies details about a certificate.
4 properties
ChangeProtectionJobStateParam
object
Specifies if the Run state of a Protection Job should change.
2 properties
ChangeServiceStateParameters
object
Specifies the parameters needed to change the state of one or more services running on the Cluster.
2 properties
ChangeServiceStateResult
object
Specifies the result returned after a successful request to change the state of services running on the Cluster.
2 properties
ChassisInfo
object
ChassisInfo is the struct for the Chassis.
5 properties
CifsShareInfo
object
Specifies information about a CIFS share of a NetApp volume.
4 properties
ClearNlmLocksParameters
object
Specifies parameters required to force clear NLM Locks.
3 properties
CloneAppViewInfoOracle
object
This message encapsulates backup view Clone operation information of a Oracle DB.
1 property
CloneAppViewInfoProto
object
This message encapsulates the information of Clone operation of backup view of an App.
1 property
CloneAppViewParams
object
This message encapsulates the generic information required for cloning and App view.
1 property
CloneDirectoryParams
object
Specifies the params that have to be provided to clone a directory.
3 properties
CloneRefreshRequest
object
Specifies the settings for creating a new clone refresh task.
8 properties
1 required
CloneTaskInfo
object
Parameters for a clone op.
2 properties
CloneTaskRequest
object
Specifies the settings for a Restore Task that clones VMs or Views.
11 properties
2 required
CloneViewRequest
object
Specifies the settings for cloning an existing View.
37 properties
CloseSmbFileOpenParameters
object
Specifies parameters required to force close an active SMB file open.
3 properties
CloudDeployInfoProto
object
Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. The extension applies…
6 properties
CloudDeployInfoProto_CloudDeployEntity
object
9 properties
CloudDeployTarget
object
Message that specifies the details about CloudDeploy target where backup snapshots may be converted and stored.
3 properties
CloudDeployTargetDetails
object
Message that specifies the details about CloudDeploy target where backup snapshots may be converted and stored.
6 properties
CloudNetworkConfiguration
object
Specifies all of the parameters needed for network configuration of the new Cloud Cluster.
5 properties
CloudParameters
object
Specifies Cloud parameters that are applicable to all Protection Sources in a Protection Job in certain scenarios.
1 property
Cluster
object
Specifies information about the Cohesity Cluster.
55 properties
ClusterAuditLog
object
Specifies information about a single Cluster audit log. When an action (such as pausing a Protection Job) occurs, an audit log is generated that provides detai…
16 properties
ClusterAuditLogConfiguration
object
Specifies the settings of the Cluster audit log configuration.
2 properties
2 required
ClusterAuditLogsSearchResult
object
Returns the Cluster audit logs that match the specified filter criteria up to the limit specified in pageCount.
2 properties
ClusterConfigProto_QoSMapping
object
If a new enum value is added to either QoSMapping.Type or QoSPrincipal.Priority in a future version, direct upgrades must be disallowed from a pre-2.5 version…
2 properties
ClusterConfigProto_QoSMapping_QoSContext
object
QoSContext captures the properties that are relevant for QoS in a request. If a new field is added to QoSContext, clusterconfig.h should be changed to enhance…
5 properties
ClusterConfigProto_SID
object
Represents the security identifier that uniquely defines a security principal. SIDs are associated with users and groups. Reference: https://msdn.microsoft.com…
3 properties
ClusterConfigProto_StoragePolicyOverride
object
1 property
ClusterConfigProto_Subnet
object
11 properties
ClusterCreationProgressResult
object
Specifies the values returned after a successful request to get the Cluster creation progress.
7 properties
ClusterHardwareInfo
object
Specifies a hardware type for motherboard of the Nodes that make up this Cohesity Cluster such as S2600WB for Ivy Bridge or S2600TP for Haswell.
2 properties
ClusterIdentifier
object
2 properties
ClusterInfo
object
2 properties
ClusterNetworkingEndpoint
object
Specifies information about end point.
3 properties
ClusterNetworkingResourceInformation
object
Specifies a resource with IP address.
2 properties
ClusterPartition
object
Provides details about a Cluster Partition.
7 properties
ClusterPublicKeys
object
Specifies public keys stored on the Cluster.
1 property
ClusterStats
object
Specifies statistics about this Cohesity Cluster.
7 properties
ClusterStatusResult
object
Specifies the result of getting the status of a Cluster.
10 properties
ClusterUpdateIpmiUsersParameters
object
Specifies the cluster level IPMI user credentials and/or Node level IPMI user credentials.
3 properties
ClusterUpdateIpmiUsersResult
object
Specifies the result returned after a request to update the IPMI user credentials.
1 property
CommonACLProto
object
Protobuf that describes the Common access control list (ACL) permissions for a swift container. TODO (avinashaita): Verify the '.rlistings' write ACL behavior.…
2 properties
CommonACLProto_Grantees
object
4 properties
CompareADObjectsResult_ADAttribute
object
6 properties
CompareADObjectsResult_ADAttributeValue
object
2 properties
CompareADObjectsResult_ADObject
object
9 properties
CompareAdObjectsRequest
object
Specifies the request to compare AD objects from Snapshot and Production AD.
7 properties
2 required
ComparedADObject
object
Represents the details about an AD object and its properties. The attributes of the AD Object contain the information about whether they are equal on both Snap…
6 properties
ConnectorParameters
object
Specifies the parameters required to establish a connection with a particular environment.
4 properties
ConnectorParams
object
Message that encapsulates the various params required to establish a connection with a particular environment.
13 properties
Consumer
object
Consumer is the storage consumer of a group.
3 properties
ConsumerStats
object
ConsumerStats is the stats of a single consumer. A consumer is a entity which consumes the storage space of a storage domain. A consumer can be a View, Protect…
9 properties
ContinuousSchedule
object
Specifies the time interval between two Job Runs of a continuous backup schedule and any blackout periods when new Job Runs should NOT be started.
1 property
CopyRun
object
Specifies details about the Copy Run for a backup run of a Job Run. A Copy task copies snapshots resulted from a backup run to a snapshot target which could be…
12 properties
CopyRunStats
object
Stats for one copy task or aggregated stats of a Copy Run in a Protection Job Run.
7 properties
CopySnapshotTaskStatus
object
Specifies the status of the copy task that copies the snapshot of a Protection Source object to a target.
6 properties
CouchbaseBackupJobParams
object
Contains any additional couchbase environment specific backup params at the job level.
CouchbaseBucket
object
Specifies an Object containing information about a couchbase Bucket.
2 properties
CouchbaseCluster
object
Specifies an Object containing information about a couchbase cluster.
1 property
CouchbaseConnectParams
object
Specifies an Object containing information about a registered couchbase source.
4 properties
CouchbaseProtectionSource
object
Specifies an Object representing Couchbase.
5 properties
CouchbaseRecoverJobParams
object
Contains any additional couchbase environment specific params for the recover job.
1 property
CountByTier
object
CountByTier provides the disk count of each storage tier.
2 properties
CreateActiveDirectoryEntryParams
object
17 properties
CreateApiKeyParams
object
Specifies the parameters to create an API key.
3 properties
1 required
CreateBondParameters
object
Specifies the parameters needed to create a bond.
3 properties
2 required
CreateBondResult
object
Specifies the result of a request to create a new bond.
1 property
CreateCloudClusterParameters
object
Specifies the parameters needed for creation of a new Cluster.
6 properties
3 required
CreateClusterResult
object
Specifies the immediate result of a Cluster creation request. Contains validation results for each node. If the request is valid, it also indicates that the in…
7 properties
CreateIdpConfigurationRequest
object
Specifies the configuration for an IdP service to be created.
12 properties
CreateIpConfigParameters
object
Specifies the parameters needed for an ipconfig request.
6 properties
1 required
CreateIpConfigResult
object
Specifies the result of a request to create an ipconfig entry.
1 property
CreatePhysicalClusterParameters
object
Specifies the parameters needed for creation of a new Cluster.
9 properties
4 required
CreateRemoteVaultRestoreTaskParameters
object
Specifies settings required to create a task that restores the index and/or the Snapshots of a Protection Job from a remote Vault to the current Cluster.
5 properties
3 required
CreateRemoteVaultSearchJobParameters
object
Specifies settings required to create a search of a remote Vault for data that has been archived from other Clusters.
7 properties
2 required
CreateViewBoxParams
object
Provides details about the Storage Domain (View Box).
15 properties
2 required
CreateViewRequest
object
Specifies the information required for creating a new View.
40 properties
2 required
CreateVirtualClusterParameters
object
Specifies the parameters needed for creation of a new Cluster.
6 properties
3 required
CreatedApiKey
object
Specifies a created API key.
11 properties
CreatedRemoteVaultSearchJobUid
object
Specifies the Uid of the Job created to search the remote vault.
1 property
Credentials
object
Specifies credentials to access a target source.
2 properties
CryptsoftKmsConfigResponse
object
4 properties
CryptsoftKmsConfiguration
object
6 properties
CryptsoftKmsUpdateParams
object
4 properties
CustomUnixIdAttributes
object
Specifies the custom attributes when mapping type is set to 'kCustomAttributes'. It defines the attribute names to derive the mapping for a user of an Active D…
2 properties
DSESolrInfo
object
2 properties
DagApplicationServerInfo
object
Specifies the information about the status of the Exchange Application Server which is a member of the DAG.
7 properties
DagInfo
object
Specifies the information about the DAG(Database availability group).
4 properties
DailyEntitlement
object
2 properties
DailySchedule
object
Specifies a daily or weekly backup schedule.
1 property
DailyUsage
object
2 properties
Dashboard
object
Data shown on Dashboard.
10 properties
DashboardResponse
object
2 properties
DataLockConfig
object
Specifies WORM retention type for the snapshots. When a WORM retention type is specified, the snapshots of the Protection Groups using this policy will be kept…
2 properties
DataLockConstraints
object
Specifies the datalock retention type and expiry time when datalock expires
2 properties
DataMigrationJobParameters
object
Specifies parameters applicable for data migration jobs in NAS environment.
9 properties
DataMigrationPolicy
object
Specifies settings for data migration in NAS environment. This also specifies the retention policy that should be applied to files after they have been moved t…
3 properties
DataTransferFromVaultPerTask
object
Specifies statistics about the transfer of data from a Vault (External Target) to this Cohesity Cluster for a recover or clone task.
4 properties
DataTransferFromVaultSummary
object
Specifies summary statistics about the transfer of data from a Vault to this Cohesity Cluster.
6 properties
DataTransferFromVaultsSummaryResponse
object
Provides summary statistics about the transfer of data from Vaults (External Targets) to this Cohesity Cluster.
1 property
DataTransferToVaultPerProtectionJob
object
Specifies statistics about the transfer of data from this Cohesity Cluster to this Vault for a Protection Job.
4 properties
DataTransferToVaultSummary
object
Specifies statistics about the transfer of data from this Cohesity Cluster to a Vault.
10 properties
DataTransferToVaultsSummaryResponse
object
Provides summary statistics about the transfer of data from this Cohesity Cluster to Vaults (External Targets).
1 property
DataUptierJobParameters
object
8 properties
DataUsageStats
object
Specifies the data usage metric of the data stored on the Cohesity Cluster or Storage Domains (View Boxes).
30 properties
DatastoreInfo
object
2 properties
DbFileInfo
object
Specifies information about a database file.
3 properties
DeleteInfectedFileParams
object
1 property
DeleteInfectedFileResponse
object
2 properties
DeleteIpConfigParameters
object
Specifies the parameters needed for an ipunconfig request.
1 property
1 required
DeleteProtectionJobParam
object
DeleteProtectionJobParam is the struct for deleting a protection job.
1 property
DeleteRouteParam
object
Specifies the delete param of a Static Route.
3 properties
DeleteViewUsersQuotaParameters
object
Specifies the user ids to remove the corresponding quota overrides in view.
3 properties
DeliveryRuleProto_DeliveryTarget
object
Delivery targets for the notifications. For now only email delivery is supported. In future, we can potentially add other delivery targets such as paging, SMS,…
8 properties
DeployCertParameters
object
Specifies the parameters used to generate and deploy a certificate.
4 properties
DeployDBInstancesToRDSParams
object
Contains RDS specfic options that can be supplied while restoring the RDS DB instance.
11 properties
DeployDBInstancesToRDSParams_PointInTimeRestoreParams
object
Message to capture details of a point in time that the DB needs to be restored to.
1 property
DeployFleetParams
object
1 property
DeployTaskRequest
object
Specifies the settings for a Deploy Task that deploys VMs on cloud.
4 properties
1 required
DeployVMsToAWSParams
object
Contains AWS specific information needed to identify various resources when converting and deploying a VM to AWS.
9 properties
DeployVMsToAzureParams
object
Contains Azure specific information needed to identify various resources when converting and deploying a VM to Azure.
16 properties
DeployVMsToCloudParams
object
Contains Cloud specific information needed to identify various resources when deploying a VM to Cloud.
6 properties
DeployVMsToCloudTaskStateProto
object
1 property
DeployVMsToGCPParams
object
Contains GCP specific information needed to identify various resources when converting and deploying a VM to GCP.
4 properties
DeployVmsToCloud
object
Specifies the details about deploying vms to specific clouds where backup may be stored and converted.
3 properties
DestroyCloneAppTaskInfoProto
object
Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. DestroyCloneAppTaskInf…
5 properties
DestroyClonedEntityInfoProto
object
Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. DestroyClonedEntityInf…
6 properties
DestroyClonedEntityInfoProto_ClonedEntity
object
2 properties
DestroyClonedTaskStateProto
object
27 properties
DestroyClonedVMTaskInfoProto
object
Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. DestroyClonedVMTaskInf…
5 properties
DestroyMountVolumesTaskInfoProto
object
7 properties
DeviceNode
object
Specifies the list of devices that need to be combined to form the storage space. Only one of the fields is populated with a device node. If the device node is…
2 properties
DeviceTree
object
A logical volume is built on a tree where leaves are the slices of partitions (PartitionSlice) defined below and intermediate nodes are assembled by combining…
6 properties
DeviceTreeDetails
object
Specifies a logical volume stored as a tree where the leaves are the blocks of partitions and intermediate nodes are assembled by combining nodes using one of…
4 properties
DeviceTree_ChildDevice
object
3 properties
DeviceTree_PartitionSlice
object
5 properties
DirQuotaConfig
object
Specifies the configuration object of a directory quota.
2 properties
DirQuotaInfo
object
Specifies the configuration and policy details for directory quota in a view.
2 properties
DirQuotaPolicy
object
Specifies a policy configuration for the directory quota. A policy is the sole entity which describes the usage limits of a directory in a view. DirPath is the…
4 properties
Disk
object
Specifies information about a disk and partitions in a volume.
8 properties
DiskBlock
object
Specifies a contiguous block by defining an offset and length of the block.
2 properties
DiskPartition
object
Specifies information about each partition in a physical disk.
5 properties
DiskUnit
object
Specifies information about a disk unit in a controller.
3 properties
DocError
object
2 properties
Domain
object
5 properties
DomainControllers
object
Domain Controllers for a domain of an Active Directory domain.
1 property
DownloadCftParams
object
2 properties
DownloadCftResponse
object
2 properties
DownloadFilesAndFoldersParams
object
DownloadFilesAndFoldersParams holds the information to create a task for downloading list of files or folders
3 properties
1 required
DownloadPackageParameters
object
Specifies the parameters needed for a request to download a new software package to a Cluster.
1 property
1 required
DownloadPackageResult
object
Specifies the result of a request to download a package to a Cluster.
1 property
EditHostsParameters
object
Specifies the parameters needed for an edit hosts request.
1 property
ElastifileCluster
object
Specifies information about a Elastifile Cluster.
5 properties
ElastifileContainer
object
Specifies information about container in an Elastifile Cluster.
8 properties
ElastifileProtectionSource
object
Specifies a Protection Source in Elastifile environment.
4 properties
EmailDeliveryTarget
object
EmailDeliveryTarget Specifies the email address and the locale setting for it.
3 properties
EmailMetaData
object
Specifies details about the emails and the folder containing emails.
19 properties
EncryptionConfiguration
object
Specifies the parameters the user wants to use when configuring encryption for the new Cluster.
3 properties
EntityIdentifier
object
Specifies a unique identifier for the entity.
1 property
EntityPermissionInformation
object
Specifies the permission information of entities.
5 properties
EntityProto
object
Specifies the attributes and the latest statistics about an entity.
3 properties
EntitySchemaProto
object
Specifies the meta-data associated with entity such as the list of attributes and time series data.
12 properties
EntitySchemaProto_AttributesDescriptor
object
Specifies a list of attributes about an entity.
2 properties
EntitySchemaProto_Granularity
object
Rolling up or Down sampling is performed on timeseries data to reduce space usage by timeseries. Rollup Granularity is defined per entity schema but rollup fun…
2 properties
EntitySchemaProto_KeyValueDescriptor
object
Specifies a key/value pair.
2 properties
EntitySchemaProto_TimeSeriesDescriptor
object
Specifies the meta-data required to define a time series of data (set of data points) for a metric.
6 properties
EntitySchemaProto_TimeSeriesDescriptor_MetricUnit
object
Specifies the unit of measure for the metric. O specifies a unit of space used such as free disk space. 1 specifies a Unix epoch Timestamp (in microseconds). 2…
1 property
EnvBackupParams
object
Message to capture any additional environment specific backup params at the job level.
13 properties
EnvironmentTypeJobParameters
object
Specifies additional parameters that are common to all Protection Sources in a Protection Job created for a particular environment type.
10 properties
ErasureCodingInfo
object
Specifies information for erasure coding.
5 properties
Error
object
Specifies the error object with error code and a message.
2 properties
ErrorProto
object
2 properties
EulaConfig
object
Specifies the End User License Agreement acceptance information.
4 properties
2 required
ExchangeBackupJobParams
object
Message to capture additional backup job params specific to Exchange.
1 property
ExchangeDAGDatabase
object
Specifies the information about all the copies of the database that is part of DAG.
3 properties
ExchangeDAGProtectionPreference
object
Specifies the information about the preference order while choosing between which database copy of the database which is part of DAG should be protected.
3 properties
ExchangeDagHostsResponse
object
Specifies if the endpoint provided in the request is standalone exchange server or not. If the endpoint is not a standalone exchange server, the list of hosts…
6 properties
ExchangeDatabaseCopyInfo
object
Specifies the information about the copy of the Exchange Database on particular Exchange Application Server that is part of DAG.
15 properties
ExchangeDatabaseInfo
object
Specifies the information about the Exchange Database.
10 properties
ExchangeEnvJobParameters
object
Specifies job parameters applicable for the Exchange Protection Jobs.
1 property
ExchangeHostInfo
object
Specifies the Information about the Exchange host.
6 properties
ExchangeProtectionSource
object
Specifies an object representing an Exchange entity. DAG - Database availability group
9 properties
ExchangeRestoreParameters
object
Specifies the exchange restore parameters.
2 properties
ExchangeRestoreViewParameters
object
3 properties
ExpandCloudClusterParameters
object
Specifies the parameters needed to expand a Cohesity Cloud Edition Cluster.
1 property
1 required
ExpandPhysicalClusterParameters
object
Specifies the parameters needed to expand a Cohesity Physical Edition Cluster.
3 properties
1 required
ExportParameters
object
ExportParameters specifies path required to export configuration.
1 property
ExtendedRetentionPolicy
object
Specifies additional retention policies to apply to backup snapshots.
6 properties
ExternalClientSubnets
object
1 property
ExternalNetworkInfo
object
This is used to display the list of external networks, from which one can potentially be selected for an app instance.
3 properties
ExtractFileRangeResult
object
This will capture output of ExtractFileRange and ExtractNFSFileRange.
5 properties
FeatureUsage
object
3 properties
FileDistributionMetrics
object
Specifies the File distribution metrics.
2 properties
FileDistributionStats
object
Specifies the File distribution stats.
5 properties
FileDistributionStatsList
array
Specifies the File distribution stats list.
FileExtensionFilter
object
3 properties
FileFstatResult
object
FileFstatResult is the struct to return the result of file Fstats.
2 properties
FileId
object
3 properties
FileLevelDataLockConfig
object
Specifies a config to lock files in a view - to protect from malicious or an accidental attempt to delete or modify the files in this view.
7 properties
FileLockStatus
object
Specifies the information of lock status for a file.
5 properties
FileNlmLocks
object
Specifies per-file NLM locks
2 properties
FilePartitionBlock
object
Defines a leaf node of a device tree. This refers to a logical partition in a virtual disk file.
4 properties
FilePathFilter
object
Specifies filters to match files and directories on a Server. Two kinds of filters are supported. a) prefix which always starts with '/'. b) posix which always…
2 properties
FilePathParameters
object
Specifies a file or a directory to protect in a Physical Server. If a directory is specified, all of its descendants are also backed up. Optionally, files or s…
3 properties
FileRestoreInfo
object
Specifies restore information of a file or a folder.
4 properties
FileSearchResult
object
Specifies details about the found file or folder.
18 properties
FileSearchResults
object
Specifies an array of found files and folders. In addition, a count is provided to indicate if additional requests must be made to get the full result.
3 properties
FileSnapshotInformation
object
Specifies the information about the snapshot that contains the file or folder. In addition, information about the file or folder is provided.
7 properties
FileStatInfo
object
4 properties
FileStubbingParams
object
File Stubbing Parameters Message to capture the additional stubbing params for a file-based environment.
9 properties
FileUptieringParams
object
8 properties
FileVersion
object
Specifies information about a single file or folder.
3 properties
FilenamePatternToDirectory
object
Specifies a filename pattern and the directory path where to keep files matching that pattern.
2 properties
FilerAuditLogConfiguration
object
Specifies the settings of the filer audit log configuration.
2 properties
2 required
FilesAndFoldersInfo
object
FilesAndFolders specifies the metadata information about the files and(or) folders for creating a download task.
2 properties
FilesToDirectoryMapping
object
2 properties
FilesystemVolume
object
Specifies information about a filesystem volume.
9 properties
FilteringPolicyProto
object
Proto to encapsulate the filtering policy for backup objects like files or directories. If an object is not matched by any of the 'allowfilters', it will be ex…
2 properties
FixedUnixIdMapping
object
Specifies the fields when mapping type is set to 'kFixed'. It maps all Active Directory users of a domain to a fixed Unix uid, and gid.
2 properties
FlashBladeFileSystem
object
Specifies information about a Flash Blade File System in a Storage Array.
8 properties
FlashBladeNetworkInterface
object
Specifies network interface detail of a Flash Blade Storage Array.
3 properties
FlashBladeNfsInfo
object
Specifies information specific to NFS protocol exposed by Pure Flash Blade file system.
1 property
FlashBladeProtectionSource
object
Specifies a Protection Source in Pure Storage FlashBlade environment.
4 properties
FlashBladeStorageArray
object
Specifies information about a Pure Storage FlashBlade Array.
6 properties
FleetNetworkParams
object
Specifies the various network params for the fleet.
3 properties
FleetParams
object
Specifies various resources when deploying a VM to Fleet instances.
3 properties
FleetTag
object
Specfies the key,value pair for the fleet tag.
2 properties
FreeNodeInformation
object
Specifies the Metadata of a free Node on the network.
11 properties
FullSnapshotInfo
object
Specifies the info regarding how to restore to a particular full or incremental snapshot.
2 properties
GcpCredentials
object
Specifies the credentials to authenticate with Google Cloud Platform.
6 properties
GcpParams
object
Specifies various resources when converting and deploying a VM to GCP.
4 properties
GcpProtectionSource
object
Specifies a Protection Source in GCP environment.
17 properties
GdprCopyTask
object
CopyTask defines the copy tasks of a job.
7 properties
GetAlertTypesParams
object
Specifies params to get alert types.
1 property
GetAllJobRunsResult
object
Specifies the common result structure of the response of all runs info ( protection, replication, archival etc.).
8 properties
GetConsumerStatsResult
object
GetConsumerStatsResult is the result of get consumerStats api.
2 properties
GetJobRunInfoResult
object
11 properties
GetMRJarUploadPathResult
object
User can upload jar files containing mappers and reducers. Iris will upload these jar files in Yoda's internal view. Yoda will mount its internal view and send…
2 properties
GetMapReduceAppRunsParams
object
GetMapReduceAppRunsParams specifies the input params to fetch the map reduce application runs.
11 properties
GetObjectsDetailsResult
object
9 properties
GetRegistrationInfoResponse
object
Specifies the registration, protection and permission information of all or a subset of the registered Protection Source Trees or Views on the Cohesity Cluster.
3 properties
GetTenantStatsResult
object
GetTenantStatsResult is the result of get tenantStats api.
2 properties
GetViewBoxStatsResult
object
GetViewBoxStatsResult is the result of get viewBoxStats api.
1 property
GetViewsByShareNameResult
object
Specifies the list of Views and Aliases by share name that matched the specified filter criteria.
2 properties
GetViewsResult
object
Specifies the list of Views returned that matched the specified filter criteria.
2 properties
Gflag
object
Specifies the attributes of a service gflag.
5 properties
1 required
GoogleAccountInfo
object
Google Account Information of a Helios BaaS user.
2 properties
GoogleCloudCredentials
object
Specifies the cloud credentials to connect to a Google service account.
4 properties
GpfsCluster
object
Specifies information about a GPFS Cluster.
3 properties
GpfsFileset
object
Specifies information about a fileset in a GPFS file system.
5 properties
GpfsFilesystem
object
Specifies information about filesystem in a GPFS Cluster.
2 properties
GpfsProtectionSource
object
Specifies a Protection Source in GPFS environment.
5 properties
GranteeProto
object
4 properties
GranularityBucket
object
Message that specifies the frequency granularity at which to copy the snapshots from a backup job's runs.
2 properties
Group
object
Specifies details about the group.
12 properties
GroupDeleteParameters
object
Specifies the groups to delete on the Cohesity Cluster.
2 properties
GroupInfo
object
Specifies struct with basic group details.
4 properties
GroupParameters
object
Specifies the settings used to add/create a new group or modify an existing group.
8 properties
GuidPair
object
Represents the guid pair of an AD Object.
2 properties
HBaseBackupJobParams
object
Contains any additional hbase environment specific backup params at the job level.
1 property
HBaseConnectParams
object
Specifies an Object containing information about a registered HBase source.
4 properties
HBaseProtectionSource
object
Specifies an Object representing HBase.
4 properties
HBaseRecoverJobParams
object
Contains any additional hbase environment specific params for the recover job.
2 properties
HBaseTable
object
Specifies an Object containing information about a HBase table.
1 property
HardwareInfo
object
This struct should match the fields in the hardware JSON file. Hardware JSON file serves as cache for hardware info to reduce hardware polling which takes time.
13 properties
HdfsBackupJobParams
object
Contains any additional hdfs environment specific backup params at the job level.
2 properties
HdfsConnectParams
object
Specifies an Object containing information about a registered Hdfs source.
5 properties
HdfsProtectionSource
object
Specifies an Object representing Hdfs.
3 properties
HdfsRecoverJobParams
object
Contains any additional hdfs environment specific params for the recover job.
3 properties
HealthTile
object
Health for Dashboard.
9 properties
HiveBackupJobParams
object
Contains any additional hive environment specific backup params at the job level.
1 property
HiveConnectParams
object
Specifies an Object containing information about a registered Hive source.
4 properties
HiveProtectionSource
object
Specifies an Object representing Hive.
4 properties
HiveRecoverJobParams
object
Contains any additional hive environment specific params for the recover job.
2 properties
HiveTable
object
Specifies an Object containing information about a Hive table.
5 properties
HostEntry
object
Specifies the parameters of a host entry that can be stored in the cluster's /etc/hosts file.
3 properties
2 required
HostInfo
object
Specifies the list of all hosts on which the certificate is deployed.
4 properties
HostResult
object
Specifies the response received after requesting a PUT, POST, or DELETE method on the /network/hosts endpoint.
1 property
HostSettingsCheckResult
object
Specifies the result of various checks performed internally on host.
3 properties
HyperFlexProtectionSource
object
Specifies a Storage Snapshot Provider in a HyperFlex environment.
4 properties
HyperVBackupEnvParams
object
Message to capture any additional backup params for a HyperV environment.
2 properties
HypervCloneParameters
object
Specifies information needed when cloning VMs in HyperV enviroment. This field defines the HyperV specific params for restore tasks of type kCloneVMs.
7 properties
HypervDatastore
object
Specifies information about a Datastore Object in HyperV environment.
4 properties
HypervEnvJobParameters
object
Specifies job parameters applicable for all 'kHyperV' Environment type Protection Sources in a Protection Job.
1 property
HypervProtectionSource
object
Specifies a Protection Source in HyperV environment.
14 properties
HypervRestoreParameters
object
Specifies information needed when restoring VMs in HyperV enviroment. This field defines the HyperV specific params for restore tasks of type kRecoverVMs.
8 properties
HypervVirtualMachine
object
Specifies information about a VirtualMachine Object in HyperV environment.
4 properties
IcapConnectionStatusResponse
object
Specifies Icap server connection status response.
2 properties
IdMappingInfo
object
Specifies the params required to update the user id mapping info of an Active Directory.
3 properties
IdpPrincipalsAddParameters
object
Specifies the settings for adding new users and groups for Idp principals. These users and groups are added to the Cohesity Cluster. You cannot create users an…
5 properties
IdpReachabilityTestResult
object
Specifies the result of the reachability test done for an IdP.
1 property
IdpServiceConfiguration
object
Specifies the configuration of an IdP service.
13 properties
IdpUserInfo
object
Specifies an IdP User's information logged in using an IdP. This information is not stored on the Cluster.
5 properties
ImportConfigurations
object
ImportConfigurations struct used for ImportConfig endpoint. This is the form of the request.
17 properties
IndexAndSnapshots
object
Specifies settings required to restore the index and Snapshots of a Protection Job.
5 properties
IndexingPolicy
object
Specifies settings for indexing files found in an Object (such as a VM) so these files can be searched and recovered. This also specifies inclusion and exclusi…
3 properties
IndexingPolicyProto
object
Proto to encapsulate file level indexing policy for VMs in a backup job.
3 properties
InfectedFile
object
Specifies the Result parameters for all infected files.
12 properties
InfectedFileId
object
Specifies the infected file Identifier. A file is identified with three Ids mentioned in the InfectedFileId definition.
3 properties
InfectedFileParam
object
4 properties
InfectedFiles
object
Specifies the Result parameters for all infected files.
2 properties
InputSpec
object
3 properties
InputSpec_FileTimeFilter
object
File time filter to filter files based on their last change time. All files whose change time is in the range [changetimerangestartsecs, changetimerangeendsecs…
2 properties
InputSpec_InputFilesSelector
object
If mapper is going to run over files on SnapFS, this selects the input files.
10 properties
InputSpec_InputVMsSelector
object
11 properties
Interface
object
3 properties
InterfaceGroup
object
Specifies the settings of an interface group.
4 properties
IoPreferentialTier
object
Specifies the preferred storage tier for IO operations.
13 properties
IopsTile
object
IOPs information for dashboard.
4 properties
IpConfig
object
Specifies the configuration of an IP.
7 properties
IpDetails
object
Entity Type | IP Address Details | Details field kHostSystem | VMKernel Adapter IP Addresses | VMKernelAdapter TODO(Matthew) : Use an enum for the 'Details'.
2 properties
IpRange
object
IP Range for range of vip address addition
2 properties
IpUnconfig
object
Specifies the unconfiguration of an IP.
3 properties
IpmiConfiguration
object
Specifies the parameters for configuration of IPMI. This is only needed for physical clusters.
4 properties
IscsiSanPort
object
Specifies an iSCSI SAN Port.
3 properties
IsilonAccessZone
object
Specifies information about access zone in an Isilon Cluster.
3 properties
IsilonCluster
object
Specifies information about an Isilon Cluster.
4 properties
IsilonMountPoint
object
Specifies information about a mount point in an Isilon OneFs Cluster.
5 properties
IsilonNfsMountPoint
object
Specifies NFS Mount Point exposed by Isilon Protection Source.
3 properties
IsilonProtectionSource
object
Specifies a Protection Source in Isilon OneFs environment.
5 properties
IsilonSmbMountPoint
object
Specifies information specific to SMB shares exposed by Isilon file system.
3 properties
JobPolicyProto
object
A message that specifies the policies to use for a job.
2 properties
JobRunsTile
object
Jon Runs information.
5 properties
KeyValuePair
object
Specifies a key/value pair.
2 properties
KeystoneACLProto
object
Protobuf that describes the Keystone access control list (ACL) permissions for a swift container. Note: Keystone ACL is applicable for only keystone authentica…
2 properties
KeystoneACLProto_Grantees
object
5 properties
KeystoneACLProto_Grantees_ProjectUsers
object
1 property
KeystoneACLProto_Grantees_ProjectUsersMapEntry
object
2 properties
KillMapReduceInstanceResult
object
1 property
KmsConfigurationResponse
object
Specifies response parameters to a KMS request.
6 properties
KmsCreateRequestParameters
object
5 properties
KmsUpdateRequestParameters
object
4 properties
KubernetesCredentials
object
Specifies the credentials to authenticate with a Kubernetes Cluster.
1 property
KubernetesProtectionSource
object
Specifies a Protection Source in Kubernetes environment.
4 properties
KubernetesRestoreParameters
object
Specifies the information required for recovering kubernetes entities.
2 properties
KvmProtectionSource
object
Specifies a Protection Source in KVM environment.
9 properties
LastProtectionRunStats
object
Specifies the stats of last Protection Run.
4 properties
LastProtectionRunStatsByEnv
object
Specifies the last Protection Run stats by env.
4 properties
LastProtectionRunSummary
object
LastProtectionRunsSummary is the summary of the last Protection Run for the Protection Jobs using the Specified Protection Policy.
7 properties
LatencyThresholds
object
Specifies latency thresholds that trigger throttling for all datastores found in the registered Protection Source or specific to one datastore.
2 properties
LatestProtectionJobRunInfo
object
Specifies the information about the Protection Runs per snapshot target.
3 properties
LatestProtectionRun
object
Specifies the information about the latest Protection Run.
9 properties
LaunchAppInstance
object
Specifies app instance parameters.
5 properties
LdapProvider
object
Specifies the configuration settings for an LDAP provider.
11 properties
LdapProviderResponse
object
LDAP provider response struct.
12 properties
LdapProviderStatus
object
LDAP provider status struct.
1 property
LegalHoldings
object
Specifies the legal holding of a Protection Source.
2 properties
LicenseAccountUsageRsp
object
Structure to hold account usage response
11 properties
LicenseState
object
Specifies the state of licensing workflow.
2 properties
LicensedUsage
object
5 properties
LifecycleConfigProto
object
Protobuf that describes the lifecycle configuration that is used to manage the lifecycle of objects in a bucket.
Links
object
The links proto to a specific resource. For example, resource, can be domain, endpoint or service.
3 properties
LinuxSupportUserBashShellAccessReqParams
object
1 property
LinuxSupportUserBashShellAccessResult
object
Specifies the result returned after a successful request to get the linux 'support' user bash shell access token,
1 property
LinuxSupportUserSudoAccessReqParams
object
1 property
LinuxSupportUserSudoAccessResult
object
Specifies the result returned after a successful request to enable/disable the linux 'support' user sudo access.
1 property
ListCentrifyZone
object
4 properties
ListCertResponse
object
Specifies list of all certificates deployed from the cluster.
1 property
ListNlmLocksResponse
object
Query response to list of NLM locks.
2 properties
ListStorageProfilesResponseBody
object
Specifies the response to request to list the storage profiles associated with a VDC.
1 property
LockFileParams
object
Specifies the parameters to lock a file in a view.
2 properties
LockRange
object
3 properties
LogicalStats
object
Provides logical statistics for logical entities such as Clusters and Domains (View Boxes). The logical size is the size of the data when it is fully hydrated…
1 property
LogicalVolume
object
Specifies attributes for a kLVM (Linux) or kLDM (Windows) filesystem.
5 properties
MORef
object
2 properties
MSExchangeParams
object
All the params specific to MS exchange application.
1 property
MagnetoInstanceId
object
3 properties
MagnetoObjectId
object
3 properties
MapReduceAuxData
object
This message encapsulates auxillary data for a MapReduce. One example of such data is saved patterns for Pattern finder app.
1 property
MapReduceFileFormats
object
Specifies information about file formats produced by a mapo reduce instance.
1 property
MapReduceInfo
object
This will be used to encapsulate information about mapper and reducer only. On UI this will be used to show the list of available apps to the user.
10 properties
MapReduceInfo_AppProperty
object
AppProperty message encapsulates properties that are same across all run instances of an app.
1 property
MapReduceInfo_RequiredProperty
object
A required property represents a property that user must set before invoking a mapreduction instance. e.g., SimpleGrepMapper will require a property named sear…
4 properties
MapReduceInstance
object
Information about a Map reduce instance. An instance can be run only once.
6 properties
MapReduceInstanceWrapper
object
MapReduceInstanceWrapper is the struct containing the map reduce instance information along with the output file path information required to download the resu…
3 properties
MapReduceInstance_InputParam
object
User can also pass Input params to run a map reduce. E.g. a grep MR will need input about what to grep.
2 properties
MapReduceInstance_RunInfo
object
18 properties
MapperInfo
object
7 properties
MappersWrapper
object
MappersWrapper is the struct to define the list of mappers.
1 property
MetricDataBlock
object
Specifies a series of metric data points for a time series.
3 properties
MetricDataPoint
object
Specifies information about a single data point in a time series.
3 properties
MetricValue
object
Specifies one data point of a metric.
3 properties
MongoDBAdditionalParams
object
Contains additional parameters required for taking backup from this Mongo cluster.
2 properties
MongoDBBackupJobParams
object
Contains any additional mongodb environment specific backup params at the job level.
1 property
MongoDBCluster
object
Specifies an Object containing information about a mongodb cluster.
1 property
MongoDBCollection
object
Specifies an Object containing information about a mongodb collection.
3 properties
MongoDBConnectParams
object
Specifies an Object containing information about a registered mongodb source.
6 properties
MongoDBDatabase
object
Specifies an Object containing information about a mongodb database.
1 property
MongoDBProtectionSource
object
Specifies an Object representing MongoDB.
6 properties
MongoDBRecoverJobParams
object
Contains any additional mongodb environment specific params for the recover job.
1 property
MonthlyEntitlement
object
2 properties
MonthlySchedule
object
Specifies a monthly backup schedule by specifying a day in the week and a week in the month. For example, if day is set to 'kMonday' and dayCount is set to 'kT…
2 properties
MonthlyUsage
object
2 properties
MountVolumeResult
object
4 properties
MountVolumeResultDetails
object
Specifies the result of mounting an individual mount volume in a Restore Task.
3 properties
MountVolumesHyperVParams
object
2 properties
MountVolumesInfoProto
object
Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. MountVolumesInfoProto…
8 properties
MountVolumesParameters
object
Specifies the information required for mounting volumes. Only required for Restore Tasks of type 'kMountVolumes'. At a minimum, the targetSourceId must be spec…
6 properties
MountVolumesParams
object
6 properties
MountVolumesState
object
Specifies the states of mounting all the volumes onto a mount target for a 'kRecoverVMs' Restore Task.
5 properties
MountVolumesTaskStateProto
object
4 properties
MountVolumesVMwareParams
object
2 properties
NasBackupParams
object
Message to capture any additional backup params for a NAS environment.
12 properties
NasCredentials
object
Specifies the server credentials to connect to a NetApp server.
5 properties
NasEnvJobParameters
object
Specifies job parameters applicable for all 'kGenericNas' Environment type Protection Sources in a Protection Job.
9 properties
NasMountCredentialParams
object
Specifies the credentials to mount a volume on a NetApp server.
8 properties
NasProtectionSource
object
Specifies a Protection Source in a Generic NAS environment.
6 properties
NetappClusterInfo
object
Specifies information about a NetApp Cluster Protection Source.
3 properties
NetappProtectionSource
object
Specifies a Protection Source in a NetApp environment.
9 properties
NetappVolumeInfo
object
Specifies information about a volume in a NetApp cluster.
12 properties
NetappVserverInfo
object
Specifies information about a NetApp Vserver in a NetApp Protection Source.
4 properties
NetworkConfiguration
object
Specifies all of the parameters needed for network configuration of the new Cluster.
7 properties
NetworkInterface
object
Specifies the properties of a network interface.
22 properties
NetworkMapping
object
Specifies the information needed when mapping the source networks to target networks during restore and clone actions.
4 properties
NetworkMappingProto
object
4 properties
NetworkParams
object
2 properties
NetworkingInformation
object
Specifies the struct containing information about network addresses configured on the given box. This is needed for dealing with Windows/Oracle Cluster resourc…
1 property
NewS3SecretAccessKey
object
1 property
NfsRootPermissions
object
Specifies the config of NFS root permission of a view file system.
3 properties
NfsSquash
object
2 properties
NimbleProtectionSource
object
Specifies a Protection Source in a Nimble environment.
4 properties
NisNetgroup
object
Defines an NIS Netgroup.
5 properties
NlmLock
object
Response map as received from view-keeper is converted into this structure. These Locks belong to one file-path.
2 properties
NoSqlBackupJobParams
object
13 properties
NoSqlConnectParams
object
8 properties
NoSqlRecoverJobParams
object
9 properties
NoSqlRecoverParams
object
1 property
NoSqlRestoreObject
object
3 properties
NoSqlRestoreObject_ObjectRestorePropertiesMapEntry
object
2 properties
Node
object
Node is the struct for a Node.
22 properties
NodeHardwareInfo
object
NodeHardwareInfo provides the information regarding the hardware.
3 properties
NodeIpmiUser
object
3 properties
NodeNetworkInterfaces
object
Specifies the network interfaces present on a specific Node in a Cluster.
5 properties
NodePort
object
VmInfo specifies information of a NodePort per service and port combination within an application instance.
3 properties
NodeStats
object
NodeStats provides various statistics for the node.
2 properties
NodeStatus
object
Specifies the status of each node in the cluster being created.
4 properties
NodeStatusResult
object
Specifies the current status of a Node in the cluster.
13 properties
NodeStopOp
object
NodeSystemDiskInfo
object
3 properties
NodeToTieredStorageDirectoriesMap
object
2 properties
NotificationRule
object
Specifies a rule to notify delivery targets such as sending emails, invoking an external api etc based on the alert type, category and severity of the generate…
10 properties
Notifications
object
All the Notification events generated for a given user. This is used for for transferring notifications over wire.
3 properties
NtpSettingsConfig
object
1 property
O365BackupEnvParams
object
Message to capture any additional backup params for Office365 environment. This encapsulates both Outlook & OneDrive backup parameters.
5 properties
O365RegionProto
object
O365Region proto will store the information about the region from where o365 connector apis calls are made.
1 property
ObjectInformation
object
9 properties
ObjectSearchResults
object
Specifies an array of backup objects and a count to indicate if additional requests must be made to get the full result.
2 properties
ObjectSnapshotInfo
object
Specifies information about an object that has been backed up.
11 properties
ObjectSnapshotType
object
2 properties
ObjectsByEnv
object
Number of Objects by Type.
2 properties
ObjectsProtectedByPolicy
object
Objects (e.g. VMs) protected by Policy.
3 properties
Office365Credentials
object
Specifies the credentials to authenticate with Office365 account.
5 properties
Office365EnvJobParameters
object
Specifies Office365 parameters applicable for all Office365 Environment type Protection Sources in a Protection Job. This encapsulates both OneDrive & Mailbox…
2 properties
Office365ProtectionSource
object
Specifies a Protection Source in Office 365 environment.
6 properties
Office365UserInfo
object
Specifies information about an Office365 user.
8 properties
OldSyslogServer
object
Specifies the syslog servers configuration to upload Cluster audit logs and filer audit logs.
9 properties
3 required
OneDriveBackupEnvParams
object
Message to capture any additonal backup params for OneDrive within the Office365 environment.
2 properties
OneDriveDocumentMetadata
object
Specifies the metadata for the OneDrive document.
1 property
OneDriveEnvJobParameters
object
Specifies OneDrive job parameters applicable for all Office365 Environment type Protection Sources in a Protection Job.
2 properties
OneDriveInfo
object
Specifies OneDrive details with the items which need to be restored.
3 properties
OneDriveItem
object
Specifies the details about OneDrive file/folder.
3 properties
OneDriveOwner
object
Specifies OneDrive owner details.
2 properties
OneDriveRestoreParameters
object
Specifies information needed for recovering Drive(s) & Drive items.
5 properties
OracleAppParams
object
Specifies special settings applicable for a app entity i.e database/dataguard.
2 properties
OracleBackupJobParams
object
Message to capture any additional backup params specific to Oracle.
2 properties
OracleCloudCredentials
object
Specifies the Oracle Cloud Credentials to connect to an Oracle S3 Compatible vault account. Oracle Cloud Credentials Region, Access-Key-Id and Secret-Access-Ke…
5 properties
OracleContainerDatabaseInfo
object
Specifies the Container Database information along with the Pluggable DBs within the container. The multitenant architecture enables an Oracle database to func…
1 property
OracleDBChannelInfo
object
Note: The name of this proto message is out-dated. This proto can represent more than just the database channel information. It should be renamed in the future.
8 properties
OracleDBChannelInfo_HostInfo
object
The name of this proto message is out-dated. This proto should generally be used to represent parameters needed for each Oracle 'cluster' node. 'cluster' here…
4 properties
OracleDBConfig
object
This proto captures the oracle database configuration for alternate DB restore.
13 properties
OracleDBConfig_PfileParameterMapEntry
object
2 properties
OracleDBConfig_RedoLogGroupConf
object
GROUP1 : {DST1/CH1.log, DST2/CH1.log} GROUP2 : {DST1/CH2.log, DST2/CH2.log} GROUP3 : {DST1/CH3.log, DST2/CH3.log}
4 properties
OracleDataGuardInfo
object
Specifies information about the Database in Oracle DataGuard configuration. Data GUard provides a comprehensive set of services that create, maintain, and moni…
2 properties
OracleDatabaseNode
object
Oracle Database Node. Specifies database node required for the backup and restore.
4 properties
OracleDatabaseNodeChannel
object
Specifies node and channel info required for the backup and restore of a database.
8 properties
OracleEnvJobParameters
object
Specifies job parameters applicable for all 'kOracle' Environment type Protection Sources in a Protection Job.
2 properties
OracleHost
object
Specifies information about an Oracle Host.
4 properties
OraclePluggableDatabaseInfo
object
Specifies the informatiomn about the pluggable database. A Pluggabele Database(PDB) is a portable collection of schemas, schema objects, and nonschema objects…
4 properties
OracleProtectionSource
object
Specifies an Object representing one Oracle database.
19 properties
OracleSbtHostParams
object
4 properties
OracleSession
object
Specifies information about session configuration for an Oracle host.
2 properties
OracleSourceParams
object
Message to capture additional backup/restore params for a Oracle source.
2 properties
OracleSpecialParameters
object
Specifies special settings applicable for 'kOracle' environment.
3 properties
OracleVlanInfo
object
4 properties
OutlookBackupEnvParams
object
Message to capture any additional backup params for Outlook within Office365 environment.
2 properties
OutlookEnvJobParameters
object
Specifies Outlook job parameters applicable for all Office365 Environment type Protection Sources in a Protection Job.
2 properties
OutlookFolder
object
Specifies the Outlook folder details.
4 properties
OutlookMailbox
object
Specifies the Outlook mailbox with restore details to support full or partial recovery.
3 properties
OutlookRestoreParameters
object
Specifies information needed for recovering Mailboxes in O365Outlook environment.
3 properties
OutputSpec
object
6 properties
Overusage
object
3 properties
OverwriteViewParam
object
Specifies the overwrite parameters for the view.
2 properties
2 required
OwnerInfo
object
1 property
PackageDetails
object
Specifies all of the details of a package that is currently installed on the cluster.
4 properties
PaginationParameters
object
Specifies the cursor based pagination parameters for Protection Source and its children. Pagination is supported at a given level within the Protection Source…
4 properties
Pattern
object
4 properties
PatternRequestBody
object
Specifies details about the pattern which has to be saved.
3 properties
3 required
PerformRestoreJobStateProto
object
Proto to define the persistent information of a wrapper restore job that spawns multiple child restore tasks.
37 properties
PerformRestoreJobStateProto_RestoreTask
object
Information of the object being restored along with the info of the task tracking the restore of that object.
3 properties
PerformRestoreTaskStateProto
object
70 properties
PhysicalBackupEnvParams
object
Message to capture any additional backup params for a Physical environment.
2 properties
PhysicalBackupSourceParams
object
Message to capture additional backup params for a Physical type source.
5 properties
PhysicalEnvJobParameters
object
Protection Job parameters applicable to 'kPhysical' Environment type. Specifies job parameters applicable for all 'kPhysical' Environment type Protection Sourc…
2 properties
PhysicalFileBackupParams
object
Message to capture params when backing up files on a Physical source.
5 properties
PhysicalFileBackupParams_BackupPathInfo
object
Describes a set of files rooted under a path that need to be backed up.
3 properties
PhysicalFileBackupParams_GlobalIncludeExclude
object
Descibes job level includes and excludes. Right now, only supports excludes but includes will be added in future.
1 property
PhysicalNodeConfiguration
object
Specifies the configuration for a node in the Cluster.
4 properties
PhysicalProtectionSource
object
Specifies a Protection Source in a Physical environment.
12 properties
PhysicalSnapshotParams
object
This message contains params that controls the snapshot process for a physical host.
4 properties
PhysicalSpecialParameters
object
Specifies additional special settings applicable for a Protection Source of 'kPhysical' type in a Protection Job.
8 properties
PhysicalVolume
object
Specifies volume information about a Physical Protection Source.
12 properties
PostgresNodeInfo
object
Specifies the Node Id, IP and port information to access the postgres database.
5 properties
PowerStateConfigProto
object
1 property
Preferences
object
1 property
PreferredDomainController
object
Specifies Preferred domain controllers (DCs) for an Active Directory domain.
2 properties
Principal
object
Specifies information about a single Principal.
5 properties
PrivilegeInfo
object
Specifies details about a privilege such as the category, description, name, etc.
9 properties
ProductModelInterfaceTuple
object
Specifies a group of product model and interface set.
2 properties
Project
object
4 properties
ProtectObjectParameters
object
Specifies the parameters to protect an object.
3 properties
2 required
ProtectedObject
object
Provides details about a Protected Object.
3 properties
ProtectedObjectPrivileges
object
ProtectedObjectPrivileges specifies which protected objects are allowed to be accessed by an app instance.
2 properties
ProtectedObjectsByEnv
object
Number of Protected Objects by Type.
5 properties
ProtectedObjectsSummary
object
Specifies the statistics of the protected objects on the cluster.
5 properties
ProtectedObjectsSummaryByEnv
object
Specifies the protection summary of given environment type.
5 properties
ProtectedObjectsTile
object
Protected Objects information.
5 properties
ProtectedSourceSummary
object
ProtectedSourceSummary is the summary of all the Protection Runs for the Protection Jobs using the Specified Protection Policy. This is only populated for a po…
7 properties
ProtectedVmInfo
object
Specifies the Protection Jobs information of a VM.
4 properties
ProtectionInfo
object
dataLocation defines data location related information.
9 properties
ProtectionJob
object
Provides details about a Protection Job.
56 properties
4 required
ProtectionJobAuditTrail
object
Specifies the fields for Protection job audit Response.
3 properties
ProtectionJobInfo
object
Specifies basic information about a Protection Job.
3 properties
ProtectionJobRequestBody
object
Specifies information about a Protection Job.
44 properties
4 required
ProtectionJobRunStats
object
Specifies statistics about a Protection Job Run. This contains the Job Run level statistics.
16 properties
ProtectionJobSummary
object
8 properties
ProtectionJobSummaryForPolicies
object
ProtectionJobSummaryForPolicies is the summary of a Protection Jobs associated with the Specified Protection Policy. This is only populated for a policy of typ…
3 properties
ProtectionJobSummaryStats
object
Specifies statistics about a Protection Job.
10 properties
ProtectionObjectSummary
object
10 properties
ProtectionPolicy
object
30 properties
ProtectionPolicyRequest
object
Specifies information about a Protection Policy.
26 properties
ProtectionPolicySummary
object
ProtectionPolicySummary specifies protection summary of a given Protection Policy.
6 properties
ProtectionRunErrors
object
3 properties
ProtectionRunInstance
object
Specifies the status of one Job Run. A Job Run can have one Backup Run and zero or more Copy Runs.
7 properties
ProtectionRunResponse
object
Specifies the information about the Protection Runs across all snapshot target locations.
3 properties
ProtectionRunsStats
object
Specifies the Protection Runs statistics response.
3 properties
ProtectionRunsSummary
object
ProtectionRunsSummary is the summary of the all the Protection Runs for the Protection Jobs using the Specified Protection Policy.
6 properties
ProtectionShellInfo
object
6 properties
ProtectionSource
object
Specifies a generic structure that represents a node in the Protection Source tree. Node details will depend on the environment of the Protection Source.
34 properties
ProtectionSourceAndApplicationRestoreObjects
object
Specifies the details about the protection source and snapshot from where the application objects must be restored. It also provides information about the appl…
2 properties
1 required
ProtectionSourceNode
object
Many different node types are supported such as 'kComputeResource' and 'kResourcePool'.
9 properties
ProtectionSourceResponse
object
Specifies the information about the individual object from search api response.
6 properties
ProtectionSourceSnapshotInformation
object
Specifies details about a Snapshot that backups up a leaf Protection Source Object.
13 properties
ProtectionSourceTreeInfo
object
Specifies the registration and protection information of a registered Protection Source Tree on the Cohesity Cluster. Many different Protection Source trees ar…
7 properties
ProtectionSourceUid
object
Specifies universal id of the Protection source specific to a cluster.
4 properties
ProtectionSourcesJobRunsReportElement
object
Specifies a Protection Source and the Snapshots that back it up.
2 properties
ProtectionSourcesJobsSummaryReportResponseWrapper
object
1 property
ProtectionSourcesSummaryStats
object
Specifies Job Run (Snapshot) summary statistics about the specified leaf Protection Source Object (such as a VM).
18 properties
ProtectionStats
object
Protection Statistics.
3 properties
ProtectionSummary
object
Specifies the number of protected and unprotected objects, and their sizes information of the given entity.
4 properties
ProtectionSummaryByEnv
object
ProtectionSummaryByEnv specifies the number of protected and unprotected objects that is break down by environment.
5 properties
ProtectionTile
object
Protection information and statistics.
4 properties
ProtectionTrend
object
Specifies details of a protected object with it's protection trends.
11 properties
PublicFolder
object
Specifies the O365 PublicFolder details.
3 properties
PublicFoldersBackupEnvParams
object
Message to capture any additional backup params for Public Folders within Office365 environment.
1 property
PublicFoldersRestoreParameters
object
Specifies information needed for recovering O365 Public Folders in O365Publicfolders environment.
3 properties
PureProtectionSource
object
Specifies a Protection Source in a Pure environment.
4 properties
QStarServerCredentials
object
Specifies the server credentials to connect to a QStar service to manage the media Vault.
7 properties
QoS
object
Specifies the Quality of Service (QoS) Policy for the View.
2 properties
QoSPolicy
object
Specifies the Quality of Service (QoS) Policy details.
11 properties
QuotaAndUsageInView
object
Specifies the usage and quota information for a specific view.
4 properties
QuotaPolicy
object
Specifies a quota limit that can be optionally applied to Views and View Boxes. At the View level, this quota defines a logical limit for usage on the View. At…
3 properties
RdsParams
object
Specifies rds params for the restore operation.
10 properties
1 required
RecoverDisksTaskStateProto
object
2 properties
RecoverTaskRequest
object
Create a Restore Task Request for recovering VMs or mounting volumes to mount points.
20 properties
2 required
RecoverVirtualDiskInfoProto
object
Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. RecoverVirtualDiskInfo…
10 properties
RecoverVirtualDiskParams
object
4 properties
RecoverVirtualDiskParams_VirtualDiskMapping
object
3 properties
RecoverVolumesParams
object
3 properties
RecoverVolumesParams_Mapping
object
2 properties
RecoverVolumesTaskStateProto
object
2 properties
RecoverVolumesTaskStateProto_TaskResult
object
3 properties
RecoveriesTile
object
Recoveries information.
4 properties
RecoveryTaskInfo
object
Parameters for a recovery op.
3 properties
ReducerInfo
object
7 properties
ReducersWrapper
object
ReducersWrapper is the struct to define the list of reducers.
1 property
RegisterApplicationServersParameters
object
Specifies the parameters required to register Application Servers running in a Protection Source.
5 properties
RegisterProtectionSourceParameters
object
Specifies the parameters required to register a Protection Source.
36 properties
RegisterRemoteCluster
object
Specifies the settings required for registering a remote Cluster on this local Cluster.
20 properties
RegisteredAppInfo
object
5 properties
RegisteredApplicationServer
object
Specifies an Application Server and the Protection Source that registered the Application Server.
2 properties
RegisteredSourceInfo
object
Specifies information about a registered Source.
29 properties
RemoteCluster
object
Specifies information about a remote Cluster that has been registered for replication.
19 properties
RemoteHost
object
Specifies the settings required to connect to a remote host.
2 properties
RemoteHostConnectorParams
object
3 properties
RemoteJobScript
object
Provides details about the Remote Adapter associated with a 'kPuppeteer' Protection Job.
5 properties
RemoteProtectionJobInformation
object
Specifies details about the original Protection Job and its Snapshots, that were archived to a remote Vault.
4 properties
RemoteProtectionJobRunInformation
object
Specifies details about a Protection Job Runs (Snapshots).
5 properties
RemoteProtectionJobRunInstance
object
Specifies details about one Job Run (Snapshot) archived to a remote Vault that was captured by a Protection Job.
7 properties
RemoteRestoreIndexingStatus
object
Specifies the status of an indexing task.
9 properties
RemoteRestoreSnapshotStatus
object
Specifies the status of a restore Snapshot task.
8 properties
RemoteScriptPathAndParams
object
Specifies the path to the remote script and any parameters expected by the remote script.
5 properties
RemoteScriptProto
object
Message to encapsulate the information of script that can be executed either before or after the backup is taken.
3 properties
RemoteVaultRestoreTaskStatus
object
Specifies the status of a remote Vault restore task.
6 properties
RemoteVaultSearchJobInformation
object
Specifies information about a search of a remote Vault.
10 properties
RemoteVaultSearchJobResults
object
Specifies detailed information about Job Runs of Protection Jobs found by a search Job when searching a remote Vault for archived data.
13 properties
RenameObjectParamProto
object
Message to specify the prefix/suffix added to rename an object. At least one of prefix or suffix must be specified. Please note that both prefix and suffix can…
2 properties
RenameViewParam
object
Specifies the rename parameters for the view.
1 property
1 required
ReplicaInfo
object
Specifies the Replication information about a snapshot.
3 properties
ReplicateSnapshotsToAWSParams
object
Params required to replicate snapshots to another AWS source. This is populated for AWS snapshot manager replication.
1 property
ReplicateSnapshotsToAzureParams
object
This is populated for Azure snapshot manager replication.
4 properties
ReplicationEncryptionKeyReponse
object
Specifies the encryption key that is used for encrypting replication data from this Cluster to a remote Cluster.
1 property
ReplicationTarget
object
Message that specifies the details about a remote cluster where backup snapshots may be replicated to.
2 properties
ReplicationTargetSettings
object
Specifies settings about the Remote Cohesity Cluster where Snapshots are copied to.
2 properties
RequestError
object
Details about the Error.
2 properties
ResetS3SecretKeyParameters
object
Specifies the parameters required to reset the S3 secret access key for the specified Cohesity user.
3 properties
RestoreADAppObjectParams
object
8 properties
RestoreAcropolisVMParam
object
2 properties
RestoreAcropolisVMParam_NetworkConfigInfo
object
Proto to define the network configuration to be applied to the restored VM.
2 properties
RestoreAcropolisVMParam_NetworkConfigInfo_NICSpec
object
2 properties
RestoreAcropolisVMsParams
object
5 properties
RestoreAppObject
object
Message that captures information about an application object being restored.
4 properties
RestoreAppObjectParams
object
7 properties
RestoreAppParams
object
This message captures all the necessary arguments specified by the user to restore an application.
4 properties
RestoreAppTaskStateProto
object
4 properties
RestoreCountByObjectType
object
Number of restore operations by object type.
2 properties
RestoreEnvStats
object
Specifies the aggregated statistics for restores of a specific environment type.
3 properties
RestoreExchangeParams
object
3 properties
RestoreExchangeParams_DatabaseOptions
object
1 property
RestoreExchangeParams_ViewOptions
object
3 properties
RestoreFileCopyStats
object
This message captures the progress information regarding restore of file/directory.
7 properties
RestoreFileResultInfo
object
This message captures result of restore of individual file or directory as initiated from magneto. Note, it is expected that the agents go through the "estimat…
5 properties
RestoreFilesInfoProto
object
Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. RestoreFilesInfoProto…
8 properties
RestoreFilesParams
object
This message captures all the necessary arguments specified by the user to restore files to the source.
29 properties
RestoreFilesParams_DirectoryNameSecurityStyleMapEntry
object
2 properties
RestoreFilesPreferences
object
This message captures preferences from the user while restoring the files on the target.
10 properties
RestoreFilesTaskRequest
object
Specifies information about a Restore Task that recovers files and folders.
17 properties
RestoreFilesTaskStateProto
object
2 properties
RestoreHyperVVMParams
object
7 properties
RestoreInfo
object
Specifies the info regarding a full SQL snapshot.
12 properties
RestoreInfoProto
object
Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. The extension applies…
5 properties
RestoreInfoProto_RestoreEntity
object
9 properties
RestoreKVMVMsParams
object
6 properties
RestoreKubernetesNamespacesParams
object
4 properties
RestoreO365PublicFoldersParams
object
3 properties
RestoreO365PublicFoldersParams_PublicFolder
object
Proto to capture the restore details of a Public Folder
4 properties
RestoreO365PublicFoldersParams_RootPublicFolder
object
3 properties
RestoreObject
object
16 properties
RestoreObjectDetails
object
Specifies an object to recover or clone or an object to restore files and folders from. A VM object can be recovered or cloned. A View object can be cloned. To…
9 properties
RestoreObjectParams
object
8 properties
RestoreObjectState
object
Specifies the state of an individual object in a Restore Task.
5 properties
RestoreOneDriveParams
object
5 properties
RestoreOneDriveParams_DriveItem
object
This will be set in case of partial drive recovery.
3 properties
RestoreOneDriveParams_DriveOwner
object
2 properties
RestoreOneDriveParams_DriveOwner_Drive
object
3 properties
RestoreOracleAppObjectParams
object
7 properties
RestoreOracleAppObjectParams_AlternateLocationParams
object
For restoring to alternate location this message can not be empty and all the fields inside the message also can not be empty.
6 properties
RestoreOracleAppObjectParams_KeyValuePair
object
This defines the restore Shell environment.
2 properties
RestoreOutlookParams
object
3 properties
RestoreOutlookParams_Folder
object
This will be set in case of partial mailbox recovery.
4 properties
RestoreOutlookParams_Mailbox
object
3 properties
RestorePointsForTimeRange
object
Specifies the info returned by Magneto RestorePointsForTimeRange API.
2 properties
RestorePointsForTimeRangeParam
object
Specifies the request parameters to restore points for time range API.
5 properties
1 required
RestoreSiteParams
object
5 properties
RestoreSiteParams_DriveItem
object
This will be set in case of partial drive recovery.
3 properties
RestoreSiteParams_SiteOwner
object
2 properties
RestoreSiteParams_SiteOwner_Drive
object
4 properties
RestoreSourceSummaryByObjectTypeElement
object
RestoreSourceSummaryByObjectTypeElement represents a recover/clone summary for a single object type.
8 properties
1 required
RestoreSqlAppObjectParams
object
18 properties
RestoreStats
object
Specifies the restore statistics details.
3 properties
RestoreTask
object
Specifies information about a Restore Task.
34 properties
1 required
RestoreTaskAdditionalParams
object
Message to encapsulate the additional parameters associated with a restore task.
2 properties
RestoreTaskStateBaseProto
object
20 properties
RestoreTaskWrapper
object
1 property
RestoreVMwareVMParams
object
10 properties
RestoreWrapperProto
object
If this message is a checkpoint record in WAL-logging or if this message is used to send restore task info back to the user, it will contain the info of the re…
6 properties
RestoredFileInfo
object
13 properties
RestoredFileInfoList
object
1 property
RestoredObjectNetworkConfigProto
object
6 properties
RestoredObjectVCDConfigProto
object
7 properties
RetentionPolicyProto
object
Message that specifies the retention policy for backup snapshots.
3 properties
RetrieveArchiveInfo
object
Proto to describe information about the retrieval of an archive task as provided by Icebox.
13 properties
RetrieveArchiveInfo_RetrievedEntity
object
Proto to define the info about the entity that was retrieved from an archive.
10 properties
RetrieveArchiveTaskStateProto
object
Persistent state of a retrieve of an archive task. Only one of either entityvec or downloadfilesinfo needs to be specified in this proto, where entityvec is fo…
22 properties
RetrieveArchiveTaskStateProto_DownloadFilesInfo
object
Information required for Icebox when downloading files from an archived entity. This proto is specifically just for the current temporary solution for download…
6 properties
Role
object
Specifies information about role such as the category, privileges, description, etc. A role can be a default system role or a custom role. Custom roles are use…
9 properties
RoleCreateParameters
object
Specifies the parameters required to create a new custom role such as the name, description and the privileges to assign to the role.
3 properties
RoleDeleteParameters
object
Specifies the parameters required for deleting one or more roles.
1 property
1 required
RoleUpdateParameters
object
Specifies parameters required to update a role.
2 properties
RootPublicFolder
object
Specifies the RootPublicFolder with restore details to support full or partial recovery.
3 properties
Route
object
Specifies the settings of a Static Route.
5 properties
RpoPolicySettings
object
Specifies all the additional settings that are applicable only to an RPO policy. This can include storage domain, settings of different environments, etc.
6 properties
RpoSchedule
object
Specifies an RPO Schedule.
2 properties
RunDiagnosticsMessage
object
Specifies the status of an Run Diagnostics request.
1 property
RunJobSnapshotTarget
object
Specifies settings for a Copy Task when a Protection is run. It gives the target location for the Snapshot and its retention.
6 properties
RunMapReduceInstanceResult
object
2 properties
RunMapReduceParams
object
RunMapReduceParams specifies the input params to run a map reduce instance.
4 properties
RunNowParameters
object
Specifies the parameters of a Run Now operation. A Run Now operation will try to backup the a source and/or its databases instantly.
3 properties
RunNowPhysicalParameters
object
Specifies optional physical parameters for a specific source id.
1 property
RunProtectionJobParam
object
Specify the parameters to run a protection job.
5 properties
RunUid
object
Specifies the universal id of the latest successful Protection Job Run.
2 properties
S3BucketConfigProto
object
7 properties
S3BucketConfigProto_TagMapEntry
object
2 properties
S3ViewBackupProperties
object
// -----------------------------------------------------------------------------
5 properties
SQLServerInstanceVersion
object
Specifies the Server Instance Version.
5 properties
SalesforceAccountInfo
object
Salesforce Account Information of a Helios user.
2 properties
Sample
object
Specifies a sample of data collected at a timestamp.
3 properties
SanEnvJobParameters
object
Specifies job parameters applicable for all SAN Environment types Protection Sources in a Protection Job.
1 property
SanStorageArray
object
Specifies a SAN Storage Array.
4 properties
SanVolume
object
Specifies a SAN Volume in a SAN Storage Array.
5 properties
SchedulerProto
object
Specifies the scheduler structure which holds the various schedule jobs.
1 property
SchedulerProto_SchedulerJob
object
Specifies the structure of the scheduler job along with its attributes.
7 properties
SchedulerProto_SchedulerJob_Schedule
object
A message which specifies the schedule of execution of the job.
3 properties
SchedulerProto_SchedulerJob_ScheduleJobParameters
object
1 property
SchedulerProto_SchedulerJob_ScheduleJobParameters_ReportJobParameter
object
2 properties
SchedulerProto_SchedulerJob_ScheduleJobParameters_ReportJobParameter_Report
object
5 properties
SchedulerProto_SchedulerJob_ScheduleJobParameters_ReportJobParameter_Report_Parameters
object
25 properties
SchedulingPolicy
object
Specifies settings that define a backup schedule for a Protection Job.
5 properties
SchedulingPolicyProto
object
5 properties
SchedulingPolicyProto_ContinuousSchedule
object
1 property
SchedulingPolicyProto_DailySchedule
object
Sample protos: Every n days (n = 1) Ex: For every 2 days, { frequency : 2 } Weekly schedule (Few selected weekdays) Ex: For every Monday, Tuesday { days : {kMo…
2 properties
SchedulingPolicyProto_MonthlySchedule
object
2 properties
SchedulingPolicyProto_RPOSchedule
object
1 property
SchemaInfo
object
Specifies the metric data point where public data metric name as key and the schema defined metric name as a value.
4 properties
ScriptExecutionStatus
object
4 properties
ScriptPathAndParams
object
A message to encapsulate pre or post script associated with a backup job policy.
5 properties
SearchProductionAdObjectsRequest
object
Specifies the request to search AD objects from Production AD.
4 properties
SendSnmpTestTrapResult
object
Specifies the result returned after a successful request to send SNMP Test Trap.
1 property
ServiceGflags
object
Specifies the gflags for a service.
2 properties
ServiceProcessEntry
object
Specifies the name of a Service running on the Cluster as well as a list of process IDs associated with that service.
2 properties
ServiceStateResult
object
Specifies the result of querying the state of a specific service on the Cluster.
2 properties
SetupRestoreDiskTaskInfoProto
object
Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. SetupRestoreDiskTaskIn…
7 properties
Share
object
Specifies the share details when request is made for list of shares filtered by ShareName parameter.
13 properties
SharePointRestoreParameters
object
Specifies information needed for recovering SharePoint Site and items.
5 properties
SharepPointSiteBackupEnvParams
object
Message to capture any additional backup params for SharePoint within the Office365 environment.
1 property
SharepointDocumentMetadata
object
Specifies the metadata for the Sharepoint Site document.
1 property
ShowSystemLedInfoParameters
object
Specifies the local or remote node for which system LED details are requested.
1 property
ShowSystemLedInfoResult
object
Specifies the result returned after a successful request to show system LED details.
1 property
SiteDriveInfo
object
Specifies the Site's Document Library drive info.
4 properties
SiteDriveItem
object
Specifies details about a Site's Drive item.
3 properties
SiteOwner
object
Specifies the details about a SharePoint Site owner.
2 properties
SmbActiveFileOpensResponse
object
Query response to SMB active file opens.
2 properties
SmbActiveFilePath
object
Specifies a file path in an SMB view that has active sessions and opens.
4 properties
SmbActiveOpen
object
Specifies an active open of an SMB file, its access and sharing information.
5 properties
SmbActiveSession
object
Specifies an active session and its opens.
6 properties
SmbConnection
object
10 properties
SmbPermission
object
Specifies information about a single SMB permission.
6 properties
SmbPermissionsInfo
object
Specifies information about SMB permissions.
2 properties
SmbPrincipal
object
4 properties
SnapshotArchivalCopyPolicy
object
Specifies settings for copying Snapshots External Targets (such as AWS or Tape). This also specifies the retention policy that should be applied to Snapshots a…
7 properties
SnapshotAttempt
object
Specifies information about a single snapshot.
3 properties
SnapshotCloudCopyPolicy
object
Specifies settings for copying Snapshots to Cloud. This also specifies the retention policy that should be applied to Snapshots after they have been copied to…
7 properties
SnapshotCopyTask
object
Specifies information about copy tasks such as replication and archival tasks.
4 properties
SnapshotInfo
object
Specifies details about the snapshot task created to backup or copy one source object like a VM.
6 properties
SnapshotInfoProto
object
Each available extension is listed below along with the location of the proto file (relative to magneto/connectors) where it is defined. The only exception is…
27 properties
SnapshotLabel
object
Specifies the snapshot label for incremental and full backup of Secondary Netapp volumes (Data-Protect Volumes).
2 properties
SnapshotManagerParams
object
1 property
SnapshotReplicationCopyPolicy
object
Specifies settings for copying Snapshots to Remote Clusters. This also specifies the retention policy that should be applied to Snapshots after they have been…
8 properties
SnapshotTarget
object
Message that specifies details about a target (such as a replication or archival target) where a backup snapshot may be copied to.
4 properties
SnapshotTargetPolicyProto
object
Message that specifies the policy for copying backup snapshots to a target. This message also specifies the retention policy that should be applied to the snap…
6 properties
SnapshotTargetSettings
object
Specifies settings about a target where a copied Snapshot is stored. A target can be a Remote Cluster or an Archival External Target such as AWS or Tape.
4 properties
SnapshotVersion
object
Specifies information about snapshots of a backup object.
12 properties
SourceAppParams
object
This message contains params specific to application running on the source such as a VM or a physical host.
2 properties
SourceBackupStatus
object
Specifies the source object to protect and the current backup status.
13 properties
SourceFilters
object
For SQL, this filters will be applicable only for auto protect sources and can be used at the host, instance level.
1 property
SourceFilters_SourceFilter
object
Plain text filter: { sourcefilter: "TestDatabase", isregex: false}. Wildcard filter: { sourcefilter: "Test?Database", isregex: false}. Regex filter: { sourcefi…
2 properties
SourceForPrincipalParam
object
Set Access Permissions for a Principal. For the specified principal, grant access permissions to the the specified Protection Sources and View names.
3 properties
SourceSpecialParameter
object
Specifies additional special settings for a single Source in a Protection Job. This Source must be a leaf node in the Source tree.
10 properties
SourcesForSid
object
Protection Sources and Views With Access Permissions. Specifies the Protection Sources objects and Views that the specified principal has permissions to access…
3 properties
SqlAagHostAndDatabases
object
Specifies AAGs and databases information on an SQL server. If AAGs exist on the server, specifies information about the AAG and databases in the group for each…
5 properties
SqlBackupJobParams
object
Message to capture additional backup job params specific to SQL.
14 properties
SqlEnvJobParameters
object
Specifies job parameters applicable for all 'kSQL' Environment type Protection Sources in a Protection Job.
10 properties
SqlProtectionSource
object
Specifies an Object representing one SQL Server instance or database.
16 properties
SqlRestoreParameters
object
Specifies the parameters specific the Application Server instance.
11 properties
SqlSourceId
object
Specifies a unique id for a SQL Protection Source.
3 properties
SqlUpdateRestoreTaskOptions
object
2 properties
SslCertificateConfig
object
SslCertificateConfig represents the SSL certificate object exposed to the user.
3 properties
SslVerification
object
Specifies information about SSL verification when registering certain sources.
2 properties
StatsGroup
object
StatsGroup describes the details of a stats group. A stats group is a basic group of usage stats, it is the usage of a tenant within a storage domain may also…
8 properties
StopRemoteVaultSearchJobParameters
object
Request to stop a remote Vault search Job.
1 property
StorageDomainStats
object
7 properties
StorageEfficiencyTile
object
StorageEfficiencyTile gives tile information for the storage saved because of compression and dedupe done on the cluster.
14 properties
StoragePolicy
object
Specifies the storage options applied to a Storage Domain (View Box).
11 properties
StoragePolicyOverride
object
Specifies if inline deduplication and compression settings inherited from Storage Domain (View Box) should be disabled for this View.
1 property
StorageSnapshotProviderParams
object
2 properties
StorageStats
object
Specifies the storage statistics of the cluster.
7 properties
StubbingPolicyProto
object
Stubbing jobs do not use protection policies. Instead, schedule and retention policy will be embedded in the BackupJobProto.
2 properties
Subnet
object
Defines a Subnet (Subnetwork). The netmask can be specified by setting netmaskBits or netmaskIp4. The netmask can only be set using netmaskIp4 if the IP addres…
10 properties
SupportedConfig
object
Lists the supported Erasure Coding options for the number of Nodes in the Cohesity Cluster. In addition, the minimum number of Nodes supported for this Cluster…
2 properties
SupportedPattern
object
Specifies details of the pattern available for search available in an application such as Pattern Finder within Analytics Work Bench.
4 properties
SwiftContainerTaggingProto
object
2 properties
SwiftParams
object
Specifies the parameters of Swift configuration.
2 properties
TagAttribute
object
Specifies a VMware tag.
4 properties
TagsOperationParameters
object
7 properties
TagsOperationResult
object
1 property
TapeMediaInformation
object
Provides information about a single tape media in a QStar Archive Vault.
3 properties
Task
object
Specifies one task.
13 properties
TaskAttribute
object
This contains a string name, a value, and a type for the value.
3 properties
TaskEvent
object
Specifies events that clients can attach to a task.
4 properties
TaskNotification
object
Structure that captures Task Notifications for a user.
14 properties
Tenant
object
Specifies details about a tenant.
24 properties
TenantActiveDirectoryUpdate
object
Specifies Active Directory update details response about a tenant.
2 properties
TenantActiveDirectoryUpdateParameters
object
Specifies Active Directory update details about a tenant.
2 properties
TenantConfig
object
Specifies struct with basic tenant specific configuration.
4 properties
TenantCreateParameters
object
Specifies the settings used to create/add a new tenant.
8 properties
TenantDeletionInfo
object
TenantDeletionInfo captures the individual deletion state of a category of objects marked tagged with a tenantid (which has been marked for deletion).
6 properties
TenantEntityUpdate
object
Specifies entity update details response about a tenant.
2 properties
TenantEntityUpdateParameters
object
Specifies entity update details about a tenant.
2 properties
TenantGroupUpdateParameters
object
Specifies group update details about a tenant.
2 properties
TenantIdData
object
Specifies id of a tenant.
1 property
TenantInfo
object
Specifies struct with basic tenant details.
2 properties
TenantLdapProviderUpdate
object
Specifies Ldap Provider update details response about a tenant.
2 properties
TenantLdapProviderUpdateParameters
object
Specifies Ldap Provider update details about a tenant.
2 properties
TenantProtectionJobUpdate
object
Specifies protection Job update details response about a tenant.
2 properties
TenantProtectionJobUpdateParameters
object
Specifies protection job update details about a tenant.
2 properties
TenantProtectionPolicyUpdate
object
Specifies protection policy update details response about a tenant.
2 properties
TenantProtectionPolicyUpdateParameters
object
Specifies protection policy update details about a tenant.
2 properties
TenantProxy
object
Specifies the data for tenant proxy which has been deployed in tenant's enviroment.
3 properties
TenantStats
object
5 properties
TenantUpdate
object
Specifies update details about a tenant.
7 properties
TenantUserUpdateParameters
object
Specifies user update details about a tenant.
2 properties
TenantViewBoxUpdate
object
Specifies view box update details response about a tenant.
2 properties
TenantViewBoxUpdateParameters
object
Specifies view box update details about a tenant.
2 properties
TenantViewUpdate
object
Specifies view update details response about a tenant.
2 properties
TenantViewUpdateParameters
object
Specifies view update details about a tenant.
2 properties
TenantVlanUpdate
object
Specifies vlan update details response about a tenant.
2 properties
TenantVlanUpdateParameters
object
Specifies vlan update details about a tenant.
2 properties
TestIdpReachability
object
Specifies the parameters to test the reachability of an IdP.
2 properties
ThrottlingPolicyOverride
object
Specifies throttling policy override for a Datastore in a registered entity.
3 properties
ThrottlingPolicyParameters
object
Specifies the throttling policy for a registered Protection Source.
6 properties
ThroughputTile
object
Throughput information for dashboard.
4 properties
Time
object
A message to encapusulate time of a day. Users of this proto will have to store the timezone information separately. For example, when this proto is part of a…
2 properties
TimeOfAWeek
object
Specifies a time period by specifying a single daily time period and one or more days of the week, for example 9 AM - 5 PM on Monday, Wednesday or Friday. If d…
4 properties
TimeOfDay
object
Specifies a time in day with hours and minutes.
2 properties
TimeRangeSettings
object
Specifies the time range struct.
3 properties
TimeSeriesSchemaResponse
object
Specifies the Apollo schema to list the data point.
1 property
TrendingData
object
Specifies protection runs information per object, aggregated over a period of time.
7 properties
UnRegisterApplicationServersParameters
object
Specifies the parameters required to unregister Application Servers running in a Protection Source.
1 property
UniversalId
object
Specifies an id for an object that is unique across Cohesity Clusters. The id is composite of all the ids listed below.
3 properties
UniversalIdProto
object
3 properties
UnprotectObjectParams
object
Specifies the parameters to unprotect an object.
3 properties
2 required
UpdateAntivirusServiceGroupParams
object
5 properties
2 required
UpdateApiKeyParams
object
Specifies the parameters to update an API key.
3 properties
1 required
UpdateAppInstanceSettingsParameters
object
Specifies update app instance settings parameters.
2 properties
UpdateAppInstanceStateParameters
object
Specifies update app instance state parameters.
1 property
UpdateApplicationServerParameters
object
Specifies the parameters required to modify the parameters of previously registered Application Servers in a Protection Source.
5 properties
UpdateBondParameters
object
Specifies the parameters needed to modify the bonding mode of a bond.
4 properties
2 required
UpdateBondResult
object
Specifies the result of a request to update a new bond.
1 property
UpdateClusterParams
object
Specifies the configuration settings that can be updated on the Cohesity Cluster.
30 properties
UpdateDirQuotaArgs
object
Specifies the arguments for updating the directory quota policies. This structure can be used for adding, updating and removing the policies.
3 properties
UpdateEulaConfig
object
Specifies the update to the End User License Agreement information.
1 property
UpdateGflagParameters
object
Specifies the parameters for updating service gflags.
4 properties
1 required
UpdateIdpConfigurationRequest
object
Specifies the parameters of an IdP configuration to be updated.
9 properties
UpdateIgnoredTrustedDomainsParams
object
Specifies the params to update the list of ignored trusted domains.
1 property
UpdateInfectedFileParams
object
2 properties
UpdateInfectedFileResponse
object
2 properties
UpdateLdapProviderParam
object
Specifies the update LDAP provider params.
12 properties
UpdateLdapProviderParams
object
Specifies the params to update the LDAP provider info.
1 property
UpdateLinuxPasswordReqParams
object
Specifies the user input parameters.
3 properties
2 required
UpdateLinuxPasswordResult
object
Specifies the result returned after a successful request to update the linux password.
1 property
UpdateMachineAccountsParams
object
Specifies the parameters required to update the machine accounts of an active directory.
4 properties
UpdateNotifications
object
Specifies the list of notificationIds and the operation to be performed.
2 properties
UpdateProtectionJobRun
object
Specifies a Job Run and the expiration time to update. The expiration time defines the retention period for the Job Run and its snapshots.
4 properties
UpdateProtectionJobRunsParam
object
Specifies the Job Runs to update with a new expiration times.
1 property
UpdateProtectionJobsState
object
2 properties
UpdateProtectionJobsStateRequestBody
object
Specifies the parameters to perform an action of list of Protection Jobs.
2 properties
UpdateProtectionObjectParameters
object
Specifies the parameters to update a Protection Object.
4 properties
1 required
UpdateProtectionSourceParameters
object
UpdateProtectionSourceParameters defines a public data definition for updating protection source.
26 properties
UpdateResolutionParams
object
Apply an existing Resolution to a new list of Alerts, which are specified by Alert Ids.
1 property
UpdateRestoreTaskParams
object
UpdateRestoreTaskParams holds the information to update a Restore Task in Magneto.
4 properties
UpdateSourcesForPrincipalsParams
object
Set Access Permissions for Principals. Specifies a list of principals to set access permissions for. For each principal, set the Protection Sources and View na…
1 property
UpdateTrustedDomainEnableParams
object
Specifies the params to update trusted domain enable flag.
1 property
UpdateUserQuotaSettingsForView
object
Specifies the parameters to update user quota metadata in a view.
4 properties
UpdateViewAliasParam
object
Specifies the parameters of updating view alias op.
6 properties
UpdateViewParam
object
Specifies the settings that define a View.
34 properties
UpgradeClusterParameters
object
Specifies the parameters needed for a Cluster Upgrade request.
1 property
1 required
UpgradeClusterResult
object
Specifies the result returned from a request to upgrade a Cluster.
2 properties
UpgradeNodeParameters
object
Specifies the parameters needed for a Node upgrade request.
4 properties
UpgradeNodeResult
object
Specifies the result returned from a request to upgrade a Node.
2 properties
UpgradePhysicalAgentsMessage
object
Specifies the status of an upgrade request.
1 property
UpgradePhysicalServerAgents
object
Specifies a request to upgrade the Cohesity agents on one or more Physical Servers registered on the Cohesity Cluster.
1 property
1 required
UploadMRJarViewPathWrapper
object
UploadMRJarViewPathWrapper contains jar name and local mount path where the Jars will be uploaded.
2 properties
UploadPackageResult
object
Specifies the result of a request to upload a package to a Cluster.
1 property
UsageAndPerformanceStats
object
Provides usage and performance statistics for entities such as a disks, Nodes or Clusters.
14 properties
UsageSchemaInfo
object
UsageSchemaInfo describes the schema info of the usage.
1 property
User
object
Specifies details about a user.
28 properties
UserDeleteParameters
object
Specifies the users to delete on the Cohesity Cluster.
3 properties
UserId
object
Specifies the mapping between an Unix and an SMB SID.
2 properties
UserIdMapping
object
Specifies how the Unix and Windows users are mapped in an Active Directory.
4 properties
UserInfo
object
Specifies struct with basic user details.
4 properties
UserInformation
object
A message to encapsulate information about the user who made the request. Request should be filtered by these fields if specified so that only the objects that…
4 properties
UserParameters
object
Specifies the settings used to create/add a new user or modify an existing user.
13 properties
UserPreferencesResult
object
Specifies the result of user preference.
1 property
UserQuota
object
Specifies the quota policy applied to a user.
3 properties
UserQuotaAndUsage
object
Specifies the quota override and usage statistics for a particular user.
4 properties
UserQuotaSettings
object
Specifies the quota settings parameters for a particular user.
2 properties
UserQuotaSummaryForUser
object
Speifies the summary of quota information for a particular user.
3 properties
UserQuotaSummaryForView
object
Specifies the user quota summary information/result for a view.
4 properties
UserSshKey
object
UserSshKey specifies username and ssh key.
2 properties
UuidConfigProto
object
1 property
VCloudDirectorInfo
object
2 properties
VMwareBackupEnvParams
object
Message to capture any additional backup params for a VMware environment.
4 properties
VMwareBackupSourceParams
object
Message to capture additional backup params for a VMware type source.
3 properties
VMwareDiskExclusionProto
object
This message contains basic info of the disk to be excluded from backup. The info contained here: 1. should be enough to identify the disk during the backup jo…
3 properties
VMwareObjectId
object
Specifies a unique Protection Source id across Cohesity Clusters. It is derived from the id of the VMware Protection Source.
3 properties
VMwareProtectionSource
object
Specifies a Protection Source in a VMware environment.
17 properties
Value
object
Specifies a data type and data field used to store data.
2 properties
Value_Data
object
Specifies the fields to store data of a given type. Specify data in the appropriate field for the current data type.
4 properties
Vault
object
Specifies an external storage location and is equivalent to an External Target in the Cohesity Dashboard. A Vault can provide an additional Cloud Tier where co…
24 properties
VaultBandwidthLimits
object
VaultBandwidthLimits represents the network bandwidth limits while uploading/downloading data to/from the external media.
2 properties
VaultConfig
object
Specifies the settings required to connect to a specific Vault type. For some Vaults, you must also specify a storage location (bucketName).
7 properties
VaultDeleteParams
object
4 properties
VaultEncryptionKey
object
Specifies the encryption information needed to restore data.
5 properties
VaultParams_RestoreParams
object
1 property
VaultParams_RestoreParams_Glacier
object
1 property
VaultProviderStatsByEnv
object
Specifies the Vault stats by environments.
3 properties
VaultProviderStatsInfo
object
Specifies the stats for each vault.
11 properties
VaultProviderStatsList
array
Specifies the stats by provider for each vault.
VaultRunInfo
object
Specifies the information about a specific vault run.
2 properties
VaultRunStatsSummary
object
Specifies the stats by run type for each vault run.
6 properties
VaultStats
object
Specifies the storage usage on vaults.
8 properties
VaultStatsInfo
object
Specifies the stats for each vault.
4 properties
VcdStorageProfile
object
Specifies a storage profile for use while recovering to a VMware VCD.
2 properties
View
object
Specifies settings for defining a storage location (called a View) with NFS and SMB mount paths in a Storage Domain (View Box) on the Cohesity Cluster.
54 properties
ViewAlias
object
Specifies the parameters of a view alias.
8 properties
ViewBox
object
Provides details about a Storage Domain (View Box).
22 properties
2 required
ViewBoxPairInfo
object
Specifies a pairing between a Storage Domain (View Box) on local Cluster with a Storage Domain (View Box) on a remote Cluster. When replication is configured b…
4 properties
ViewBoxStats
object
Provides statistics about the Storage Domain (View Box).
6 properties
ViewIdMappingProto_FileLevelDataLockConfig
object
7 properties
ViewIdMappingProto_ProtocolAccessInfo
object
5 properties
ViewParams
object
7 properties
ViewPrivileges
object
ViewPrivileges specifies which views are allowed to be accessed by an app instance.
2 properties
ViewProtection
object
Specifies information about the Protection Jobs that are protecting the View.
3 properties
ViewProtectionSource
object
Specifies a Protection Source in a View environment.
3 properties
ViewProtocolStats
object
Specifies the View Protocol stats.
3 properties
ViewProtocolStatsList
array
Specifies the View Protocol stats List.
ViewStatInfo
object
Specifies the View stats per view.
12 properties
ViewStats
object
Provides statistics about the View.
2 properties
ViewStatsSnapshot
object
Specifies the list statistics for each View for a given timestamp.
2 properties
ViewTimeSeriesStats
object
Specifies the View Time Series stats.
2 properties
ViewTimeSeriesStatsList
array
Specifies the View Time Series stats list.
ViewUserQuotaParameters
object
Specifies the params to create and edit a user quota policy in a view.
2 properties
ViewUserQuotas
object
Specifies the Result parameters for all user quotas of a view.
6 properties
VirtualDiskId
object
This message defines the proto that can be used to identify the disks in different environments.
4 properties
VirtualDiskIdInformation
object
Specifies information about virtual disk which includes disk uuid, controller type, bus number and unit number.
4 properties
VirtualDiskInfo
object
4 properties
VirtualDiskInformation
object
8 properties
VirtualDiskMapping
object
Specifies the request data struct for virtual disk mapping with only the disk ids.
3 properties
VirtualDiskMappingResponse
object
Specifies information about virtual disks where a user can specify mappings of source disk and destination disk to overwrite.
3 properties
VirtualDiskRecoverTaskState
object
Specifies the complete information about a recover virtual disk task state.
4 properties
VirtualDiskRestoreParameters
object
Specifies the parameters to recover virtual disks of a vm.
4 properties
VirtualDiskRestoreResponse
object
Specifies the parameters to recover virtual disks of a vm with full Protection Source.
4 properties
VirtualNodeConfiguration
object
Specifies the configuration for a node in the Cluster.
3 properties
Vlan
object
Specifies the settings of a VLAN. Its used by both Request and Response structures.
20 properties
VlanParameters
object
Specifies VLAN parameters for the restore operation.
3 properties
VlanParams
object
3 properties
VmDirEntry
object
VmDirEntry is the struct to represent a file or a folder on a VM.
4 properties
VmDirectoryListResult
object
VmDirectoryListResult is a struct containing information about each directory entry.
2 properties
VmGroup
object
VmGroup specifies information of a VM Group.
2 properties
VmInfo
object
VmInfo specifies information of a VM.
4 properties
VmNameInfo
object
Struct containing vm-name and ui-name (to be displayed on the UI to get number of replicas as input) as members.
2 properties
VmNumReplicas
object
2 properties
VmVolumesInformation
object
Specifies information about a logical volume found a VM.
1 property
VmwareCloneParameters
object
Specifies the information required for recovering or cloning VmWare VMs.
17 properties
VmwareEnvJobParameters
object
Specifies job parameters applicable for all 'kVMware' Environment type Protection Sources in a Protection Job.
3 properties
VmwareRestoreParameters
object
Specifies the information required for recovering or cloning VmWare VMs.
19 properties
VmwareSpecialParameters
object
Specifies additional special settings applicable for a Protection Source of 'kVMware' type in a Protection Job.
3 properties
VolumeInfo
object
11 properties
VolumeInfo_DiskInfo
object
8 properties
VolumeInfo_DiskInfo_PartitionInfo
object
Offset/Length here is relative to the logical range starting at 0, formed by mapping the physical ranges of the disk into a linear device.
5 properties
VolumeInfo_DiskInfo_PhysicalRange
object
2 properties
VolumeInfo_LogicalVolumeInfo
object
This is extra attribute which uniquely identifies a logical volume in LVM or LDM.
5 properties
VolumeSecurityInfo
object
Specifies information about NetApp volume security settings.
4 properties
VserverNetworkInterface
object
Specifies information about a logical network interface on a NetApp Vserver. The interface's IP address is the mount point for a specific data protocol, such a…
3 properties
WebHookDeliveryTarget
object
WebHookDeliveryTarget Specifies the external api url to hit along with the related options for it.
2 properties
WindowsHostSnapshotParameters
object
Specifies settings that are meaningful only on Windows hosts.
4 properties
WormRetentionProto
object
Message that specifies the WORM attributes. WORM attributes can be associated with any of the following: 1. backup policy: compliance or administrative policy…
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cohesity 3
Other APIs Cohesity publishes across the network.
Cohesity Helios REST API
Cohesity Helios Reporting API
Cohesity Site Continuity API
#Backup#DataProtect#Disaster Recovery#Per-Cluster
Where this information came from
This is an independent, third-party profile of Cohesity DataProtect REST API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.