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
Update a syslog server by id.
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
Get an Active Directory by id.
get
Update an Active Directory.
put
Delete an Active Directory.
del
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
Get Centrify Zones.
get
Get Domain Controllers of specified domains.
get
Get the list of Active Directories.
get
Register an Active Directory.
post
Get Domain Controllers of specified domains.
get
Search AD Principals by prefix
post
Refresh trusted domains of AD config.
put
Update an Active Directory.
put
Unregister an Active Directory.
post
Get Trusted Domains.
get
Rediscover trusted domains.
put
Update trusted domains.
post
Alert
Get alert categories.
get
Get alert types.
get
Get alerts.
get
Get alerts summary.
get
List all notification rules
get
Add a notification rule
post
Update a notification rule
put
Remove a notification rule
del
Get alert resolutions.
get
Create alert resolution.
post
Get alert resolution by resolution Id
get
Update alert resolution.
put
Get list of helios alerts.
get
List the Alert Resolutions in Cohesity system.
get
Create an Helios Alert Resolution.
post
Returns if SNMP is configured and supported SNMP alerts on Helios.
get
Compute the stats on active alerts.
get
Get alerts summary on Helios.
get
Get active alert statistics.
get
AntivirusService
Get Antivirus Service groups.
get
Create an Antivirus Service group.
post
Update an Antivirus Service group with given parameters or if state is specified, enable or disable given group.
put
Delete an Antivirus Service group
del
Get ICAP Uri connection status.
get
Get infected entities.
get
Update infected entities state.
put
Delete infected files.
del
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
Get Group by SID
get
Update Group
put
Delete Group
del
Get a list of available tenant access available to the logged in User.
get
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
Update or validate linux user password.
put
Get sessions count
get
Create a user session
post
Delete user sessions
del
Get User by SID.
get
Update User information.
put
Delete a Cohesity (LOCAL/IdP/AD) user.
del
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
Get the API key by id.
get
Update a user API key.
put
Delete a user API key.
del
Refresh an existing user API key.
post
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
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
Get helios audit logs.
get
Get helios audit logs actions.
get
Get helios audit logs cluster users.
get
Download helios audit logs.
get
Get helios audit logs entity types.
get
Get Helios Audit Log Settings.
get
Update Helios Audit Log Settings.
put
Create cluster audit logs.
post
CohesityCA
/cert-manager/exchange-ca-certs
post
Platform
Get list of chassis
get
Get a chassis by chassis id.
get
Update a chassis by chassis id.
patch
Retrieve Cluster Configuration
get
Update a cluster.
put
Create a cluster.
post
Update Airgap config
put
Get AMQP Target Config
get
Update AMQP Target Config
put
Delete AMQP Target Config
del
Sets/clears the BaseOS upgrade cluster operation.
put
Update feature flag override status.
put
Gets cluster gflags for a service.
get
Update the gflags
put
List Host Mappings
get
Update Host Mappings
put
Create Cluster Host Mappings
post
Deletes multiple Host Mappings within the cluster
post
Import Crl File
put
Get Cluster Local Domain SID
get
Get Cluster Metadata
get
List Nodes of the cluster.
get
List the free Cohesity Nodes present on a network.
get
Get cluster operations status.
get
Get packages
get
Upload package by files
post
Restore configuration.
get
Update Restore configuration.
put
List services states
get
Change cluster services states.
post
Get SMTP configuration.
get
Update SMTP configuration.
put
Clear SMTP configuration.
del
Validate SMTP configuration.
post
Get cluster snapshot policy.
get
Update cluster snapshot policy.
put
Delete cluster snapshot policy.
del
Get Software Components
get
Get cluster software history
get
Update cluster software
put
Get the SSH public key.
post
Get cluster state
get
Get cluster status.
get
Get cluster subnets info.
get
Update the Cluster Subnets
put
Run upgrade checks on cluster.
put
Get upgrade checks results.
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
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 get IPMI User Info for node
get
To update IPMI User Info for node
post
To delete IPMI User for node
del
To verify IPMI User with Password for node
post
Get Kubernetes Infra Health Status
get
Get login banner.
get
Update login banner.
put
Get list of interfaces
get
Create a new network bond.
post
Get interface groups
get
Create interface group
post
Update interface group
put
Delete interface group
del
Get vlans
get
Create vlan
post
Get vlan
get
Update vlan
put
Delete vlan
del
Reboot or shutdown nodes in cluster.
post
Fetch Node Hardware Information
get
Import a signed certificate used for n2n communication
post
Fetch Node status Information
get
Fetch Node General Information
get
Upgrade a free node.
put
Identify node
post
Mark Node for removal
post
Get list of NTP servers.
get
Update NTP servers.
put
Get list of proxy servers
get
Creare a proxy server.
post
Update specified proxy server.
put
Remove specified proxy server.
del
Get list of racks
get
Create racks
post
Update racks
patch
Get a rack by rack id.
get
/racks/{id}
patch
Get support channel configuration.
get
Update support channel configuration.
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
List the specified Certificate Signing Request.
get
Delete a Certificate Signing Request on the cluster.
del
Get the anomaly details.
get
Updates the anomaly notification threshold.
put
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
Get list of SSL certificates.
get
List all Certificates with cluster trust store.
get
Register CA Certificate to the cluster trust store.
post
List the specified Certificate.
get
Unregister CA Certificate from the cluster trust store.
del
Validate CA Certificate.
post
Tenant
Get Tenants Config.
get
Update Tenants Config.
post
Get Tenants Config.
get
Update Tenant's Config.
patch
Get Tenant's config for all clusters.
get
Update Tenant's config for clusters.
post
Get a list of tenants.
get
Create a new Tenant on Helios.
post
Get Tenant Statistics.
get
Delete a Tenant on Helios.
del
Update Tenant properties on Helios.
patch
Perform actions on a Helios Tenant.
post
Assign properties to a tenant.
put
Assign a Cluster to a tenant.
post
Enable Helios Management for Tenant.
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
Update Tenant.
put
Delete Tenant with given ID.
del
Perform actions on a Tenant.
post
Get tenant assignments.
get
Update assginment of properties for a tenant.
put
Config
Get SNMP configuration.
get
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
Query for difference of graph node relations
post
Detailed differences of graph nodes
post
Agent
Download agent
post
Get upgrade tasks
get
Create an upgrade task
post
Perform action on an upgrade task.
post
Download agent
post
Get agent images details.
get
CloudDomain
/data-protect/attach-cloud-domain
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
List details about single External Target.
get
Update a External Target.
put
Delete a External Target.
del
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
Get the status of latest failover for the all specified Backup and Recovery instances. Here the Backup and Recovery instance refers to the vault.
get
Initiate a failover for the specified Backup and Recovery instance. Here the Backup and Recovery instance refers to the vault.
post
Initiate an action e.g. cancel the in-progress failover
post
Get the status of all the past and current failover for the specified Backup and Recovery instance. Here the Backup and Recovery instance refers to the vault.
get
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
Delete Metadata with Entity
del
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 the CSV of errors/warnings for a given run and an object.
get
Get the CSV of various Messages for a given run.
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
Modify objects in source hierarchy.
put
Get Object activity on Helios.
post
Get Object activity on Helios.
get
Get last protection run of objects.
post
Associate Metadata with Entity
put
Update multiple runs of one or more objects.
put
List the snapshots for a given object.
get
Get stats for a given object.
get
Get the object archival run stats.
get
Get the list of Protected Objects
get
Get the summary for a given object.
get
GetTenantObjectIds
post
Policy
List Protection Policies based on provided filtering parameters.
get
Create a Protection Policy.
post
List details about a single Protection Policy.
get
Update a Protection Policy.
put
Delete a Protection Policy.
del
Get the protection policy summary
get
List Policy Templates filtered by query parameters.
get
List details about a single Policy Template.
get
List Policies based on provided filtering parameters.
get
Create a Policy.
post
List details about a single Protection Policy.
get
Update a Protection Policy.
put
Delete a Policy.
del
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
List details about single Protection Group.
get
Update a Protection Group.
put
Delete a Protection Group.
del
Get the list of runs for a Protection Group.
get
Update runs for a particular Protection Group.
put
Create a new protection run.
post
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
Get Protection Group activity on Helios.
post
Get the list of Protection Groups.
get
Create a Protection Group.
post
List details about single Protection Group.
get
Update a Protection Group.
put
Delete a Protection Group.
del
Get the list of indexing runs summary for a given range.
get
Recovery
Lists the Recoveries.
get
Performs a Recovery.
post
Delete a restore clone task
del
Fetches the children of a directory
get
Create a download files and folders recovery.
post
Fetches the uptier data.
get
Fetches information of virtual disks
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
List Restore Points in a given time range
post
Download an indexed file.
get
Get Recoveries on Helios.
get
Get Recovery by Id on Helios.
get
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
Search for indexed objects.
post
Source
Get a List of Protection Sources.
get
The Application Servers in a Protection Source tree.
get
Registers or update owner entity with applications.
put
Delete an application server registration.
del
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/Update Microsoft 365 Azure Applications for a given domain.
put
Create Microsoft 365 Azure Applications for a given domain.
post
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 the list of Microsoft365 Self-Service configurations
get
Create or Update the Self-Service configuration for a Microsoft365 source.
put
Deletes the Self-Service configuration for a Microsoft365 source.
del
Get the list of Protection Source registrations.
get
Register a Protection Source.
post
Get a Protection Source registration.
get
Update Protection Source registration.
put
Delete Protection Source Registration.
del
Perform Partial Update on Protection Source registration. Currently this API is supported only for Cassandra
patch
Test connection to a source.
post
Get VDC Details.
get
Get a Protection Sources.
get
Refresh a Protection Source.
post
Get Network Entities within a Resource pool
get
Get a List of Protection Sources.
get
Register a Protection Source.
post
Get a Protection Source registration.
get
Update Protection Source registration.
put
Delete Protection Source Registration.
del
Test connection to a source.
post
Templates
Download the azure resource template.
get
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
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
Get data tiering analysis group by id.
get
Update a data tiering analysis group. Currently, it supports updating sources and schedule only.
put
Delete data tiering analysis group.
del
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
Get data tiering task by id.
get
Update a data tiering task.
put
delete the data tiering task.
del
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
Get MFA Preferences
get
Update MFA Preferences
put
Initiate OTP from Helios.
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.
put
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
Migrate S3 Views.
post
Get NLM locks.
get
Clear NLM locks.
del
Get QoS Policies.
get
Get Shares.
get
Create a Share.
post
Update a Share.
put
Delete a Share.
del
Get SMB File opens.
get
Close SMB File open.
del
Get View Clients.
get
Get View Clients Summary.
get
List View Templates
get
Create a View Template
post
Read a View Template by Id
get
Update a View Template
put
Delete a View Template
del
List Views
get
Create a View
post
Get Views summary.
get
Clone View Directory.
post
Get a View by Id
get
Update a View
put
Delete a View
del
Clone View.
post
Get directory quotas for the View.
get
Update directory quota for the View.
put
Delete directory quota for the View.
del
Get file lock status
get
Create a file-lock
post
Overwrite View.
post
Get View user quotas.
get
Update View user quota settings.
put
Add User Quota overrides.
post
Delete user quota overrides.
del
Update user quota override.
put
Get View user quotas.
get
FortknoxOnprem
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
Get a Fortknox Onprem Primary Cluster by id.
get
Update the registration of a Fortknox Onprem Primary Cluster.
put
Unregister an Fortknox Onprem Primary Cluster.
del
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
Get whether the cluster is a vault cluster.
get
Update whether the cluster is a vault cluster.
put
HeliosOnPrem
Retreive Helios OnPrem Configuration
get
Update Helios OnPrem Configuration
put
Registration
Register to Helios.
post
Lists the Helios Registration Config.
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
IdentityProvider
Get Identities
get
Configure Identity Provider
post
Perform Identity Action
post
Update Identity Provider
put
Delete Identity Provider
del
Get identity providers
get
Configure identity provider
post
Login to cluster using idp
get
Update identity provider
put
Delete identity provider
del
Create an Identity Provider Configuration.
post
Authenticate IdP By ID
post
Get the list of IDP configurations.
get
Create an Identity Provider Configuration.
post
List IDP Principals
get
Create an Identity Provider Configuration.
post
Get IDP Principal by SID
get
Update IDP Principal.
put
Delete an IDP Principal.
del
List details about single Identity Provider configuration.
get
Update IDP Configuration.
put
Delete a IDP configuration.
del
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
Get a Keystone by its id.
get
Update a Keystone configuration.
put
Delete a Keystone configuration.
del
KeyManagementSystem
Get KMS
get
Add KMS
post
Update KMS
put
Delete KMS
del
LDAP
Get Groups.
get
Update Ldap provider.
put
Create Ldap provider.
post
Delete LDAP provider.
del
Get LDAP connection status.
get
LSU
GET LSU.
get
Create LSU.
post
Pair local and remote LSU.
post
Delete LSU pairing.
del
Update LSU.
put
HeliosNotifications
Get helios notifications
get
ClusterRegistration
Fetch claim tokens for an account
get
Generate a cluster claim token
post
Delete a cluster claim token by token UUID
del
ClusterManagement
Fetch compatible clusters for release version.
get
Clusters information with upgrade details.
get
Updates scheduled cluster upgrades.
put
Initiates instant and scheduled cluster upgrade.
post
Cancels scheduled cluster upgrades.
del
Fetch upgrade info.
get
Get all releases present in the db by release type.
get
CopyStats
Get copy details.
post
HeliosDataProtectStats
Data-Protect Usage Statistics
get
RPaaS Usage Statistics
get
DSPM
Get DSPM runs.
get
Perform actions for a DSPM schedule.
post
Rpaas
Get FortKnox vaults.
get
Get the RPaaS onboarding status.
get
Complete onboarding for RPaaS.
post
Get the Rpaas regions.
get
Add rpaas regions for an account.
post
Fortknox
Add KMS key config for Fortknox.
post
An endpoint to pair clusters with fortknox vaults.
post
Get Fortknox vaults.
get
Add Cohesity Fortknox vaults in a given list of regions for the given account.
post
Get transfer time configurations.
get
Perform actions on a given FortKnox vault.
post
Update transfer time configuration.
put
Get transfer time configurations.
get
Update transfer time configuration.
put
Get all entitlements for a Fortknox.
get
Reset onboarding for fortknox.
put
Get FortKnox vault usage grouped by provider and storage class.
get
HeliosIdentityProvider
Get the list of IDP configurations
get
Create an Identity Provider Configuration
post
Update an IDP Configuration
put
Delete an IDP configuration
del
HeliosPrincipals
Get all principals on helios.
get
Create a principal on helios.
post
Get a specified principal details.
get
Update a specified principal.
put
Delete a specified principal.
del
ProviderInstances
List Provider Instances
get
SecurityIntegration
List security integrations
get
Add security integration
post
Update security integration
put
Delete security integration
del
SessionManagement
Fetch Session Management Config
get
Save Session Management Config
put
Certificate
Get the Helios SSL Certificate.
get
Stats
Compute stats of last Protection Run of Protection Policies.
get
Compute stats of last Protection Run across all objects.
get
Fetch the throttling stats of a source.
get
Get Cluster Storage Stats.
get
Get Stats of Files.
get
Get statistics of protection runs.
get
Compute the statistics on the Restore tasks on the cluster.
get
Get Time Series Stats.
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
Get Stats of View Clients
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
Get Workload Stats Schema.
get
TaggingService
Adds specified tags to snapshots.
post
Removes specified tags of snapshots.
del
Get the tags of snapshots.
post
Firewall
List all firewall settings.
get
Update firewall settings.
put
List all firewall IP sets
get
Update firewall profiles & their attachments.
put
Remove firewall profiles.
put
List all firewall profiles.
get
Create a firewall profile.
post
Reset firewall profiles.
post
Update the firewall profile.
put
Remove firewall profile.
del
Routes
List all static routes
get
Configure a static route
post
Update a static route
put
Delete a static route
del
NodeGroup
List Node Groups based on provided filtering parameters.
get
Create a Node Group.
post
Update a Node Group.
put
Delete a Node Group.
del
Privilege
Get Privileges.
get
RemoteClusters
Get all registered Remote Clusters.
get
Register a Remote Cluster.
post
Validate Remote Cluster config.
post
Get Remote Cluster config by id.
get
Update a Remote Cluster config.
put
Unregister a Remote Cluster.
del
RemoteStorage
Get Registered Remote Storage Servers List
get
Register Remote Storage
post
Get remote storage details
get
Delete Remote Storage Registration
del
Update Remote Storage Config
patch
Role
Get Roles.
get
Create a Role.
post
Update a Role.
put
Delete a Role.
del
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}
get
/secret-manager/certificates/{thumbprint}
del
/secret-manager/certificates/{thumbprint}
patch
SnmpConfig
Get Snmp Config
get
Update Snmp Config
put
StorageDomain
Get Storage Domains.
get
Create a Storage Domain.
post
Get a Storage Domain by id.
get
Update a Storage Domain.
put
Delete a Storage Domain.
del
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
Get list of syslog servers.
get
Add Syslog Server
post
Remove syslog servers
del
Get cluster audit tags.
get
Update cluster audit tags.
post
Get supported program names.
get
Get supported program names.
get
Get a syslog server by id.
get
Update a syslog server by id.
put
Remove syslog server by id
del
Patch a syslog server by id.
patch
Get a syslog server reachability status.
get
Tag
Get tags based on filters.
get
Create a Tag
post
Get Tag by id.
get
Update a Tag
put
Delete a Tag
del
TenantDeactivation
/tenants/deactivations
post
/tenants/{id}/deactivation
post
Certificates
Get the Server Certificate configured on the Cluster.
get
HeliosTagging
Delete a tag by uuid.
del
List the tags.
get
Updates a tag.
post
Creates a tag.
put
Get rule information for blocking recovery.
get
Create rule information for blocking recovery.
post
Update rule information for blocking recovery.
put
Return tags for given snapshots.
get
Return tags for given snapshots.
patch
Platform
Get whether the cluster is a DMaaS cluster.
get
Update whether the cluster is a DMaaS cluster.
put
List NetBackup media servers
get
Get NetBackup media server details
get
Update NetBackup media server state
post
Get NetBackup primary server information
get
List NetBackup storage servers
get
Register NetBackup storage server
post
Unregister NetBackup storage server
del
List NetBackup tuning parameter
get
Add or update NetBackup tuning parameter
post
Delete NetBackup tuning parameter
del
To delete IPMI Users for cluster
del
RecoveryScan
Get the status of latest recovery scan for the all specified Backup and Recovery instances. Here the Backup and Recovery instance refers to the vault.
get
Initiate a recovery scan on the specified Backup and Recovery instance. Here the Backup and Recovery instance refers to the vault.
post
Initiate an action e.g. cancel the in-progress recovery scan
post
Get the status of the all the recovery scans for the specified Backup and Recovery instance. Here the Backup and Recovery instance refers to the vault.
get
Snapshots
Trigger snapshot discovery actions.
post
Stats
Get Time Series Stats for Replication Backlog.
get
/stats/replication-clusters
get
/stats/replication-data-trend
get
/stats/replication-objects
get
/stats/replication-objects-trend
get
User
Add the specified principals for the users or groups created on the Cohesity Cluster.
post
Verify the OTP for a user.
post
Get task notifications for the given user.
get
Create a new S3 key for a User
post
Delete an S3 key for a User
del
Update an S3 key for a User
put
health
Get Health Status
get
Data Insights REST API
Datasets
Get the datasets
get
Create a new dataset
post
Get the dataset details.
get
Get the datasets' details.
get
Get dataset objects run info.
get
Cancel indexing of a dataset
post
Delete the dataset
del
Update the dataset
patch
Trigger indexing of a dataset
post
Specify the action to perform on datasets
post
Get the list of dataset discovery results at a level.
get
Get the summary of a dataset discover result.
get
Generate meaningful question recommendations for the user to ask.
post
Objects
Get the objects.
get
LLMs
Get the registered LLMs
get
Register a LLM
post
Update a LLM
patch
Unregister LLM
del
Conversations
send a query to the specified llm
post
Get the chat history
get
send a query to the specified llm, receive a streaming response
post
Get the chat history for a single query Uid.
get
Search for a preview of similar documents matching input query.
put
Refine answer based on documents.
post
Refine answer based on documents, receive a streaming response
post
QueryFeedback
Provide feedback on a query response
post
Documents
Get the document details.
get
Search for similar document parts matching the input query.
post
AccountConfig
Get the configuration for Account
get
Update account config
post
Enable/Disable chat history.
post
Get llm related config for an account.
get
Update llm related config for an account.
post
ConversationBot
The cohesity Conversation AI bot.
post
GaiaAiEngineConnections
Retrieve all Gaia AI Engine connections.
get
Create a new Gaia AI Engine connection.
post
Get a Gaia AI Engine connection by ID.
get
Update a Gaia AI Engine connection.
post
Delete a Gaia AI Engine connection.
del
AuthDirectories
Retrieve registered authentication directories
get
Register a new authentication directory
post
Get a registered authentication directory
get
Update a registered authentication directory
put
Patch a registered authentication directory
patch
Unregister an authentication directory
del
GaiaEmblemRegistration
Generate an Emblem claim token
post
Fetch Emblem claim tokens metadata for an account
get
Delete an Emblem claim token by token UUID
del
GaiaUsageStats
Gaia Usage stats for a given accountID
get
SupportedRegions
Get supported regions
get
Security Center APIs
HeliosTagging
Creates a new tag.
post
Returns a list of tags.
get
Update a tag by uuid.
patch
Delete a tag by uuid.
del
Tags actions on objects or snapshots.
patch
Lists associated tags.
post
Streams
Returns stream information.
get
Creates a Stream.
post
Updates a Stream by ID.
put
Deletes a Stream by ID.
del
Performs an action on the given Stream.
post
FortKnox Service API
Fortknox
Create FortKnox vaults.
post
Get Fortknox vaults.
get
Pair clusters with fortknox vaults.
post
Add KMS key config for FortKnox.
post
Perform actions on a FortKnox vault.
post
Get FortKnox transfer time configurations.
get
Update FortKnox transfer time configuration.
put
Data Mobility APIs
Sites
Get sites.
get
Create new site.
post
Get a site by ID.
get
Delete a site by ID.
del
Update a site by ID.
put
Applications
Create a new application.
post
Get applications.
get
Get an application by ID.
get
Update an application by ID.
put
Delete an application by ID.
del
Get application versions.
get
Get replicated snapshots for an application.
get
DRPlan
Create a DR plan.
post
Get DR plans.
get
Get a DR plan by ID.
get
Delete a DR plan by ID.
del
Update a DR Plan by ID.
put
Perform an action on a DR plan.
post
Get actions.
get
Get an action by ID.
get
Perform operations on a DR plan action.
post
Reports
Export a report.
post
HealthChecks
Initiate health check.
post
Objects
Initiate asynchronous operations.
post
Get an operation by ID.
get
Stats
Get detailed statistics.
post
Helios Reporting APIs
Artifacts
Fetch report artifact for task
get
Components
List Report Components
get
Fetch a Report Component
get
Fetch Preview of components.
post
Fetch Preview of a component.
post
Filters
Get resources
post
Reports
List properties of a report type
get
List Reports
get
Fetch a Report
get
Fetch a Report Preview
post
Export a Report
post
Schedules
List all schedules.
get
Create a Schedule
post
Fetch a Schedule
get
Update a Schedule
put
Delete a Schedule
del
Run a schedule on demand.
post
Update Schedules State
post
Tasks
Fetch Tasks
get
Fetch a Task
get
Rack Appliance Management APIs
AccessToken
Create a new API access token
post
Alert
Get alerts summary.
get
BaseosPatchManagement
Applies the given baseos patch.
post
Downloads the given baseos patch.
post
Get available baseos patches
get
Get Baseos patch application log
get
Cleans up the given baseos patch files.
post
MFA
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
OneHelios
Get Health Status for Services
get
Get Helios install logs.
get
Get Helios Upgrade Logs
get
PatchManagement
Get applied patches
get
Revert patches
post
Get available patches
get
Apply patches
post
Import patches
put
Get patch operation status
get
Get patches history
get
Platform
Get list of chassis
get
Import Crl File
put
List Nodes of the cluster.
get
Get cluster operations status.
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 Kubernetes Infra Health Status
get
Fetch Node General Information
get
Identify node
post
Mark Node for removal
post
Stats
Get Time Series Stats.
get
Support
Get support user configuration.
get
Update support user configuration.
put
Validates the support user credentials.
post
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
User
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
Nimbus REST API
Backup
Get backup configuration.
get
Update backup configuration.
put
Delete backup configuration.
del
Retrieve backup statuses.
get
Trigger a backup run.
post
Retrieve backup logs for a specific run.
get
Restore
Trigger a restore run.
post
UI Configuration API
Cluster/Helios
List details about the Cohesity Cluster/Helios such as the name, type, version, language, locale and domains. This operation does not require authentication.
get
List feature flags and their current boolean status for this Cohesity Cluster/Helios. This operation does not require authentication.
get
Licensing APIs
License
Get Feature Usage Stats
get
Export Feature Usage Report
get
Get Active License Usage for Products
get
Get License Usage Details
get
Export License Usage Details Report
post
Export Entitlements
get
HeliosSelfManagedSpecific
Download audit reports for on-prem licensing
get
Import Entitlements
post
Update a syslog server by id.
put
https://example.com/v2/syslog/
{id}
Update syslog server by id.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Response
Click
Try It!
to start a request and see the response here!