Jump to Content
Getting Started
API Reference
Recipes
Marketplace
GitHub
Home
Guides
Recipes
API Reference
Changelog
Getting Started
API Reference
Recipes
Marketplace
GitHub
API Reference
Home
Guides
Recipes
API Reference
Changelog
BaseosPatchManagement
Search
All
Pages
Start typing to search…
JUMP TO
Cohesity REST API
AccessToken
Create a new API access token
post
ActiveDirectory
Get the list of Active Directories.
get
Create an Active Directory.
post
Delete an Active Directory.
del
Get an Active Directory by id.
get
Update an Active Directory.
put
Get Centrify Zones.
get
Get Domain Controllers of specified domains.
get
Get Trusted Domains.
get
Update trusted domains.
post
Rediscover trusted domains.
put
Get the list of user and group principals from the Active Directory that match the specified filter criteria.
get
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
Get Active Directory Topology
get
Alert
Get alerts summary.
get
Get alert categories.
get
Get alert types.
get
Get alerts.
get
List all notification rules
get
Add a notification rule
post
Remove a notification rule
del
Update a notification rule
put
Get alert resolutions.
get
Create alert resolution.
post
Get alert resolution by resolution Id
get
Update alert resolution.
put
Get active alert statistics.
get
AntivirusService
Get Antivirus Service groups.
get
Create an Antivirus Service group.
post
Delete an Antivirus Service group
del
Update an Antivirus Service group with given parameters or if state is specified, enable or disable given group.
put
Get ICAP Uri connection status.
get
Delete infected files.
del
Get infected entities.
get
Update infected entities state.
put
Delete infected objects permanently.
del
User
Get the list of all API keys which are created or owned by the user.
get
Get Groups.
get
Create Groups
post
Delete Groups
post
Delete Group
del
Get Group by SID
get
Update Group
put
Get Security Principals.
get
Fetch sources & views assigned to a user/group.
get
Update protection sources assigned to a user/group.
put
Get Users.
get
Add one or more users to Cohesity Cluster.
post
Delete one or more Cohesity users.
post
Delete user sessions
del
Get sessions count
get
Create a user session
post
Delete a Cohesity (LOCAL/IdP/AD) user.
del
Get User by SID.
get
Update User information.
put
Reset S3 secret access key
post
Update S3 keys for a User
post
Get the list of API keys owned by the user.
get
Create a new user API key.
post
Delete a user API key.
del
Get the API key by id.
get
Update a user API key.
put
Refresh an existing user API key.
post
Update or validate linux user password.
put
AuditLog
Get cluster audit logs.
get
Get cluster audit logs actions.
get
Get cluster audit logs entity types.
get
Get filer audit log configs.
get
Update filer audit log configs.
put
Create cluster audit logs.
post
Platform
Get list of chassis
get
Get a chassis by chassis id.
get
Update a chassis by chassis id.
patch
Run upgrade checks on cluster.
put
Get upgrade checks results.
get
Retrieve Cluster Configuration
get
Create a cluster.
post
Update a cluster.
put
Update Airgap config
put
Delete AMQP Target Config
del
Get AMQP Target Config
get
Update AMQP Target Config
put
Sets/clears the BaseOS upgrade cluster operation.
put
Update feature flag override status.
put
List Host Mappings
get
Create Cluster Host Mappings
post
Update Host Mappings
put
Deletes multiple Host Mappings within the cluster
post
Import Crl File
put
Get Cluster Local Domain SID
get
List Nodes of the cluster.
get
List the free Cohesity Nodes present on a network.
get
Get packages
get
Clear SMTP configuration.
del
Get SMTP configuration.
get
Update SMTP configuration.
put
Validate SMTP configuration.
post
Delete cluster snapshot policy.
del
Get cluster snapshot policy.
get
Update cluster snapshot policy.
put
Get the SSH public key.
post
Get cluster state
get
Assimilate disks.
post
Discover new disks
get
Identify a disk
post
Get list of disks
get
Get remote disks
get
Add remote disk
post
Remove remote disk
del
Mark Disk for removal
post
Get list of interfaces
get
Create interface group
post
Create vlan
post
Reboot or shutdown nodes in cluster.
post
Fetch Node General Information
get
Mark Node for removal
post
Get list of racks
get
Update racks
patch
Create racks
post
Get a rack by rack id.
get
/racks/{id}
patch
Get support channel configuration.
get
Update support channel configuration.
put
Gets cluster gflags for a service.
get
Update the gflags
put
Get whether the cluster is a DMaaS cluster.
get
Update whether the cluster is a DMaaS cluster.
put
Get Cluster Metadata
get
Get cluster operations status.
get
Upload package by files
post
Restore configuration.
get
Update Restore configuration.
put
List services states
get
Change cluster services states.
post
Get Software Components
get
Get cluster software history
get
Update cluster software
put
Get cluster status.
get
Get cluster subnets info.
get
Update the Cluster Subnets
put
To get IPMI LAN info for the cluster
get
To update IPMI LAN info for the cluster
put
To get IPMI users info for the cluster
get
To update IPMI Users for cluster
put
To get IPMI FRU info
get
To get IPMI LAN info
get
To get IPMI SDR Info
get
To get IPMI SEL
get
To get IPMI SEL Info
get
To reset IPMI BMC for given node
post
To delete IPMI User for node
del
To get IPMI User Info for node
get
To update IPMI User Info for node
post
To verify IPMI User with Password for node
post
Get Kubernetes Infra Health Status
get
Get login banner.
get
Update login banner.
put
Create a new network bond.
post
Get interface groups
get
Delete interface group
del
Update interface group
put
Fetch Node Hardware Information
get
Import a signed certificate used for n2n communication
post
Fetch Node status Information
get
Upgrade a free node.
put
Identify node
post
Get list of NTP servers.
get
Update NTP servers.
put
Get list of proxy servers
get
Creare a proxy server.
post
Remove specified proxy server.
del
Update specified proxy server.
put
Security
Create Certificate Signing Requests on the cluster.
post
Import the signed certificates on the cluster after the Certificate Signing Requests are created.
post
List Certificate Signing Requests on the cluster.
get
Create a Certificate Signing Request on the cluster.
post
Update the signed certificate on the cluster after a Certificate Signing Request is created.
post
Delete a Certificate Signing Request on the cluster.
del
List the specified Certificate Signing Request.
get
Get cluster security settings.
get
Update cluster security settings.
put
Gets the list of ciphers enabled on the cluster.
get
Enable/Disable a list of ciphers on the cluster. Iris must be restarted for the change to take effect.
post
Gets the list of object store ciphers enabled on the cluster.
get
Enable/Disable a list of object store ciphers on the cluster. Bridge must be restarted for the change to take effect.
post
List all Certificates with cluster trust store.
get
Register CA Certificate to the cluster trust store.
post
Unregister CA Certificate from the cluster trust store.
del
List the specified Certificate.
get
Validate CA Certificate.
post
Get list of SSL certificates.
get
Tenant
Get Tenants Config.
get
Update Tenants Config.
post
Get a list of Tenants.
get
Create a new Tenant.
post
Get a Swift configuration.
get
Update a Swift configuration.
put
Register Swift service on a Keystone server.
post
Unregister Swift service from a Keystone server.
post
Delete Tenant with given ID.
del
Update Tenant.
put
Perform actions on a Tenant.
post
Get tenant assignments.
get
Update assginment of properties for a tenant.
put
Agent
Download agent
post
Get upgrade tasks
get
Create an upgrade task
post
Perform action on an upgrade task.
post
ExternalTarget
Get the list of External Targets.
get
Create a External Target.
post
List archive media information
get
Get the list of External Target Settings.
get
Update External Target Settings
put
Delete a External Target.
del
List details about single External Target.
get
Update a External Target.
put
Get the encryption key info for an external target
get
Failover
Get the list of failover planned runs.
get
Get tracking View Id
get
Get View Failover.
get
Create View Failover Task.
post
Cancel View Failover Task.
post
Gets all the failover operations which can be performed on this view.
get
Initiate a failover request.
post
Activate failover entity backup on replication clsuter.
post
Deactivate failover entity backup on source clsuter.
post
Cancel failover workflow.
post
Linking between replicated objects and failover objects
post
Create a planned run for backup and replication.
post
Object
List all the filtered objects.
post
Get Objects.
get
Actions on Objects
post
Get last protection run of objects.
get
Associate Metadata with Entity
put
Cancel object runs.
post
Get an Object.
get
Perform an action on an object.
post
Fetch the contents (files & folders) for the specified object.
post
Get PIT ranges for an object
get
Get the list of runs for an object.
get
Get a run for an object.
get
Get diff between two snapshots of a given object.
post
List the snapshots for a given object.
get
Update an object snapshot.
put
Get stats for a given object.
get
Get the objects tree hierarchy for for an Object.
get
Get snapshots of indexed object.
get
Get snapshots of indexed object.
get
Get Metadata of Entities
get
Get details of object snapshot.
get
Construct meta info for any workflow from object snapshot and some other information.
post
Get volume info of object snapshot.
get
List objects on a source which can be used for data protection.
get
Delete Metadata with Entity
del
Get the CSV of errors/warnings for a given run and an object.
get
Get the CSV of various Messages for a given run.
get
Modify objects in source hierarchy.
put
Policy
List Protection Policies based on provided filtering parameters.
get
Create a Protection Policy.
post
Delete a Protection Policy.
del
List details about a single Protection Policy.
get
Update a Protection Policy.
put
List Policy Templates filtered by query parameters.
get
List details about a single Policy Template.
get
Get the protection policy summary
get
ProtectedObject
Create Object Backup.
post
Perform Actions on Protect Objects.
post
Update Object Backup.
put
ProtectionGroup
Get the list of Protection Groups.
get
Create a Protection Group.
post
Perform an action like pause, resume, active, deactivate on all specified Protection Groups.
post
Delete a Protection Group.
del
List details about single Protection Group.
get
Update a Protection Group.
put
Get the list of runs for a Protection Group.
get
Create a new protection run.
post
Update runs for a particular Protection Group.
put
Actions on protection group run.
post
Get a run for a Protection Group.
get
Get the debug logs for a run from a Protection Group.
get
Get the debug logs for a particular object in a run from a Protection Group.
get
Get the CSV of various Proto Messages for a given run and an object.
get
Get the CSV of errors/warnings for a given run and an object.
get
Get the list of runs.
get
Get the progress of a run.
get
Get the stats for a run.
get
Recovery
Lists the Recoveries.
get
Performs a Recovery.
post
Create a download files and folders recovery.
post
Fetches the uptier data.
get
Get Recovery for a given id.
get
Cancel Recovery for a given id.
post
Get the debug logs for a particular recovery operation.
get
Download files from the given download file recovery.
get
Get the CSV of errors/warnings for a given recovery operation.
get
Tear down Recovery for a given id.
post
Download an indexed file.
get
Delete a restore clone task
del
Fetches the children of a directory
get
Fetches information of virtual disks
get
List Restore Points in a given time range
post
CloudRetrieveTask
Get the list of cloud retrieve tasks.
get
Create a cloud retrieve task.
post
List details about the cloud retrieve task with the specific job id.
get
Search
List indexed objects.
post
List Objects.
get
List Protected Objects.
get
Source
Get a List of Protection Sources.
get
List attribute filters for a source.
get
Generate device code for Microsoft365 Device Authorization Grant flow.
post
Generate access token for Microsoft365 Device Authorization Grant flow.
post
Create Microsoft 365 Azure Applications for a given domain.
post
Create/Update Microsoft 365 Azure Applications for a given domain.
put
Get the list of Microsoft365 Self-Service configurations
get
Deletes the Self-Service configuration for a Microsoft365 source.
del
Create or Update the Self-Service configuration for a Microsoft365 source.
put
Get the list of Protection Source registrations.
get
Register a Protection Source.
post
Delete Protection Source Registration.
del
Get a Protection Source registration.
get
Perform Partial Update on Protection Source registration. Currently this API is supported only for Cassandra
patch
Update Protection Source registration.
put
Test connection to a source.
post
Get VDC Details.
get
Get a Protection Sources.
get
Refresh a Protection Source.
post
The Application Servers in a Protection Source tree.
get
Delete an application server registration.
del
Registers or update owner entity with applications.
put
Deletes Azure Applications
del
Fetches the Microsoft 365 registered Backup Controller by the Cohesity App for the owner tenant
get
Registers the Cohesity App to be the Microsoft 365 Backup Controller
post
Enables billing profile for the MBS service for the tenant.
post
Unregisters the Cohesity App as the Microsoft 365 Backup Controller
del
Updates the status of the registered M365 Backup Controller
patch
Get Network Entities within a Resource pool
get
Templates
Download the azure resource template.
get
DataTiering
Get the list of data tiering analysis groups.
get
Create a data tiering analysis group.
post
Get the default config of data tiering analysis groups.
get
Update data tiering analysis groups state.
post
Delete data tiering analysis group.
del
Get data tiering analysis group by id.
get
Update a data tiering analysis group. Currently, it supports updating sources and schedule only.
put
Update data tiering analysis group config.
put
Get data tiering analysis group runs.
get
Create a data tiering analysis group run.
post
Cancel data tiering analysis run.
post
Get capacity trend analysis for all sources or a specific source.
get
Get the list of data tiering tasks.
get
Create a data tiering task.
post
Update data tiering source analysis tasks state.
post
delete the data tiering task.
del
Get data tiering task by id.
get
Update a data tiering task.
put
Create a data tiering tasks run.
post
Cancel data tiering task.
post
Download Tiering reports.
get
MFA
Creates a new OTP to be sent to the user email.
post
Returns the current MFA configuration.
get
Stores the updated MFA configuration.
put
Creates a new OTP to be sent to the user email.
post
Returns the current MFA configuration.
get
Stores the updated MFA configuration.
patch
Creates a new OTP to be sent to the linux support user email.
post
Verify the totp code for support user.
post
Create a new TOTP secret URI and store the secret key.
post
View
Clear NLM locks.
del
Get NLM locks.
get
Get QoS Policies.
get
Get Shares.
get
Create a Share.
post
Delete a Share.
del
Update a Share.
put
Close SMB File open.
del
Get SMB File opens.
get
Get View Clients.
get
Get View Clients Summary.
get
List View Templates
get
Create a View Template
post
Delete a View Template
del
Read a View Template by Id
get
Update a View Template
put
List Views
get
Create a View
post
Get Views summary.
get
Clone View Directory.
post
Delete a View
del
Get a View by Id
get
Update a View
put
Clone View.
post
Delete directory quota for the View.
del
Get directory quotas for the View.
get
Update directory quota for the View.
put
Get file lock status
get
Create a file-lock
post
Overwrite View.
post
Delete user quota overrides.
del
Get View user quotas.
get
Add User Quota overrides.
post
Update View user quota settings.
put
Update user quota override.
put
Migrate S3 Views.
post
HeliosOnPrem
Retreive Helios OnPrem Configuration
get
Update Helios OnPrem Configuration
put
Registration
Register to Helios.
post
Lists the Helios Registration Config.
get
IdentityProvider
Get Identities
get
Configure Identity Provider
post
Perform Identity Action
post
Delete Identity Provider
del
Update Identity Provider
put
Get identity providers
get
Configure identity provider
post
Login to cluster using idp
get
Delete identity provider
del
Update identity provider
put
KerberosProvider
Get the list of Kerberos Providers.
get
Register a Kerberos Authentication Provider.
post
Get the Registered Kerberos Provider by id.
get
Update the Kerberos Provider Registration.
put
Unregister a Kerberos Provider.
post
Keystone
Get Keystones.
get
Create a Keystone configuration.
post
Delete a Keystone configuration.
del
Get a Keystone by its id.
get
Update a Keystone configuration.
put
KeyManagementSystem
Get KMS
get
Add KMS
post
Delete KMS
del
Update KMS
put
LDAP
Get Groups.
get
Create Ldap provider.
post
Update Ldap provider.
put
Delete LDAP provider.
del
Get LDAP connection status.
get
Firewall
Update firewall profiles & their attachments.
put
Remove firewall profiles.
put
List all firewall settings.
get
Update firewall settings.
put
List all firewall IP sets
get
List all firewall profiles.
get
Create a firewall profile.
post
Reset firewall profiles.
post
Remove firewall profile.
del
Update the firewall profile.
put
Routes
Configure a static route
post
List all static routes
get
Delete a static route
del
Update a static route
put
NodeGroup
List Node Groups based on provided filtering parameters.
get
Create a Node Group.
post
Delete a Node Group.
del
Update a Node Group.
put
PatchManagement
BaseosPatchManagement
Privilege
Get Privileges.
get
RemoteClusters
Get all registered Remote Clusters.
get
Register a Remote Cluster.
post
Validate Remote Cluster config.
post
Unregister a Remote Cluster.
del
Get Remote Cluster config by id.
get
Update a Remote Cluster config.
put
RemoteStorage
Get Registered Remote Storage Servers List
get
Register Remote Storage
post
Delete Remote Storage Registration
del
Get remote storage details
get
Update Remote Storage Config
patch
Role
Get Roles.
get
Create a Role.
post
Delete a Role.
del
Update a Role.
put
Stats
Get Cluster Storage Stats.
get
Get Stats of Files.
get
Get statistics of protection runs.
get
Get Time Series Stats.
get
Get Stats of View Clients
get
Get Views Stats.
get
Get Workload Stats Schema.
get
Compute the statistics on the Restore tasks on the cluster.
get
Get stats for the top views, which are the views with largest value of 'stats.valueInLastHours' for a given combination of 'metric', 'protocol' & 'lastHours' params. The API uses suitable defaults if any of the parameters are not specified.
get
StorageDomain
Get Storage Domains.
get
Create a Storage Domain.
post
Delete a Storage Domain.
del
Get a Storage Domain by id.
get
Update a Storage Domain.
put
Support
Get support user configuration.
get
Update support user configuration.
put
Validates the support user credentials.
post
Unlock the linux user account if the user gets locked out.
put
Syslog
Remove syslog servers
del
Get list of syslog servers.
get
Add Syslog Server
post
Get cluster audit tags.
get
Update cluster audit tags.
post
Get supported program names.
get
Remove syslog server by id
del
Get a syslog server by id.
get
Patch a syslog server by id.
patch
Update a syslog server by id.
put
Get a syslog server reachability status.
get
Get supported program names.
get
Tag
Get tags based on filters.
get
Create a Tag
post
Delete a Tag
del
Get Tag by id.
get
Update a Tag
put
AthenaAppOps
Relaunch app instance
put
Relaunch System App
put
App
Upload apps container image.
post
Enables or disables a service.
put
Api to get images information.
get
CohesityCA
/cert-manager/exchange-ca-certs
post
DataAccessor
Lists all the Data Access Sessions
get
Create Data Access Session
post
Search Graph nodes
post
Tear down data access session for a given id
del
Get Graph Nodes details
post
Difference of Graph nodes
post
Query for difference of graph node relations
post
CloudDomain
/data-protect/attach-cloud-domain
post
DataSourceConnection
Get data-source connections
get
Create a data-source connection
post
Returns connectivity endpoints for data-source connections
get
Get upgrade connections config.
get
Config for upgrading connections.
put
Delete the data-source connection specified by the ID in the request path.
del
Patch a data-source connection using its ID
patch
Generate registration token for a data-source connection
post
Resets the upgrade for a data-source connection
post
DataSourceConnectorLocal
Lists the data-source connector logs.
get
Register a data-source connector.
post
Lists the data-source connector status.
get
DataSourceConnector
Get data-source connectors
get
/data-source-connectors/metadata
get
/data-source-connectors/metadata
put
Delete a data-source connector using its ID
del
Patch a data-source connector using its ID
patch
FortknoxOnprem
Get whether the cluster is a vault cluster.
get
Update whether the cluster is a vault cluster.
put
Get all precheck options required for vault configuration.
get
Get all registered Fortknox Onprem Primary Clusters.
get
Register a Fortknox Onprem Primary Cluster.
post
Create connection for a Fortknox Onprem primary cluster.
post
Unregister an Fortknox Onprem Primary Cluster.
del
Get a Fortknox Onprem Primary Cluster by id.
get
Update the registration of a Fortknox Onprem Primary Cluster.
put
Refresh the API key for the Primary Cluster.
put
Check the API key for the Primary Cluster.
post
Update connection for a Fortknox Onprem primary cluster.
put
Get all registered Fortknox Onprem Vault Clusters.
get
Get all precheck options required for vault configuration.
get
Get a Fortknox Onprem Vault Cluster by id.
get
Get a list of Fortknox Onprem vaulting activities.
get
OneHelios
Get Health Status for Services
get
Get Helios install logs.
get
Perform action to enable/disable an on demand service.
put
Get status of an ondemand service
get
Get Helios Upgrade Logs
get
LSU
GET LSU.
get
Create LSU.
post
Delete LSU pairing.
del
Pair local and remote LSU.
post
Update LSU.
put
CertificateStore
/secret-manager/cert/{environment}
get
/secret-manager/cert/{environment}
post
/secret-manager/cert/{environment}/{thumbprint}
get
/secret-manager/certificates
get
/secret-manager/certificates
post
/secret-manager/certificates/{thumbprint}
del
/secret-manager/certificates/{thumbprint}
get
/secret-manager/certificates/{thumbprint}
patch
SnmpConfig
Get Snmp Config
get
Update Snmp Config
put
TenantDeactivation
/tenants/deactivations
post
/tenants/{id}/deactivation
post
BaseosPatchManagement
