Jump to Content
Getting Started
Recipes
API Reference
Marketplace
GitHub
Home
Recipes
API Reference
Getting Started
Recipes
API Reference
Marketplace
GitHub
API Reference
Home
Recipes
API Reference
Get alerts summary.
Search
JUMP TO
Helios CCS APIs
ActiveDirectory
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
Agent
Get agent images details.
get
Alert
Get list of helios alerts.
get
List the Alert Resolutions in Cohesity system.
get
Create an Helios Alert Resolution.
post
Get alerts summary on Helios.
get
AuditLog
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
Certificate
Get the Helios SSL Certificate.
get
CopyStats
Get copy details.
post
ClusterRegistration
Fetch claim tokens for an account
get
Generate a cluster claim token
post
Delete a cluster claim token by token UUID
delete
ClusterManagement
Fetch compatible clusters for release version.
get
Clusters information with upgrade details.
get
Get all releases present in the db.
get
Fetch the cluster upgrade details.
get
Updates scheduled cluster upgrades.
put
Initiates instant and scheduled cluster upgrade.
post
Cancels scheduled cluster upgrades.
delete
Fetch upgrade info.
get
DMS
Get the list of supported regions by Cohesity DMaaS across all service providers.
get
Get the list of regions enabled for a tenant in Cohesity DMaaS.
get
Add Cohesity DMaaS service in a given list of regions for the given tenant.
post
Resume the provision of Cohesity DMaaS service from the last point of failure for a tenant in a region.
patch
Get the AWS cloud sources registered in DMaaS by a tenant.
get
Update an AWS cloud source for a tenant in DMaaS.
put
Register an AWS cloud source for a tenant in DMaaS.
post
Delete an AWS cloud source registered for a tenant in DMaaS.
delete
Verify the AWS cloud source's connectivity. This is performed by trying to assume tenant's AWS IAM role internally in DMS.
get
Get the KMS key assigned by the tenant to a given region.
get
Update KMS key info that was previously added to a region within Cohesity DMaaS service.
put
Add KMS key info to a region within Cohesity DMaaS service.
post
Delete a KMS key info associated region within Cohesity DMaaS service for a given tenant.
delete
DSPM
Get DSPM runs.
get
Perform actions for a DSPM schedule.
post
HeliosDataProtectStats
Data-Protect Usage Statistics
get
RPaaS Usage Statistics
get
HeliosIdentityProvider
Get the list of IDP configurations
get
Create an Identity Provider Configuration
post
Update an IDP Configuration
put
Delete an IDP configuration
delete
HeliosNotifications
Get helios notifications
get
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.
delete
IdentityProvider
Create an Identity Provider Configuration.
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.
delete
List details about single Identity Provider configuration.
get
Update IDP Configuration.
put
Delete a IDP configuration.
delete
MFA
Get MFA Preferences
get
Update MFA Preferences
put
Initiate OTP from Helios.
post
Object
Get Object activity on Helios.
post
Get Object activity on Helios.
get
Get last protection run of objects.
post
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 summary for a given object.
get
GetTenantObjectIds
post
Policy
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.
delete
ProtectionGroup
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.
delete
Recovery
Get Recoveries on Helios.
get
Get Recovery by Id on Helios.
get
Source
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.
delete
Test connection to a source.
post
Rpaas
Return valid temporary RPaaS KMS credentials.
post
An endpoint to pair a cluster with one or more RPaaS regions.
post
Get the list of RPaaS regions enabled for a helios account and tenant
get
Add Cohesity RPaaS service in a given list of regions for the given account.
post
Remove Cohesity RPaaS region for a given account and tenant.
delete
Return valid temporary RPaaS S3 credentials.
post
Rigelmgmt
API to update the number of connectors in the AWS connection.
put
List the upload and download bandwidth limits for a connection.
get
Updates bandwidth limits for a connection.
put
Get the stats for one or more Connections.
post
Update connection.
put
Delete rigel connection.
delete
Get connector connectivity information.
get
Trigger connectivity check for SaaS connector.
post
Get rigel connectivity check endpoints.
get
Get the stats for one or more Connectors.
post
Get the download link for Rigel image.
get
Renew a claim token with group id.
post
Get the list of Rigel Group information.
get
Update SaaS connection.
put
Create Rigel Group and associated claim token.
post
Upgrade status of rigel group.
get
/mcm/rigelmgmt/rigel-groups/upgrade
post
Get the list of Rigel instance information.
get
Update rigel's name, ip and software version.
put
Delete Rigels for the given region and tenant.
delete
Claim Rigel instance.
post
Update rigel's support channel access.
put
Search
Search for indexed objects.
post
SecurityIntegration
List security integrations
get
Add security integration
post
Update security integration
put
Delete security integration
delete
Security
Get the anomaly details.
get
Updates the anomaly notification threshold.
put
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
Tenant
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.
delete
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
User
Get a list of available tenant access available to the logged in User.
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
Cancel indexing of a dataset
post
Delete the dataset
delete
Update the dataset
patch
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
put
Unregister LLM
delete
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
QueryFeedback
Provide feedback on a query response
post
Documents
Get the document details.
get
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
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.
delete
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.
delete
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.
delete
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.
delete
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.
delete
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
delete
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
delete
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
delete
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
delete
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
delete
Get sessions count
get
Create a user session
post
Delete a Cohesity (LOCAL/IdP/AD) user.
delete
Get User by SID.
get
Update User information.
put
Nimbus REST API
Backup
Get backup configuration.
get
Update backup configuration.
put
Delete backup configuration.
delete
Retrieve backup statuses.
get
Trigger a backup run.
post
Retrieve backup logs for a specific run.
get
Restore
Trigger a restore run.
post
Get alerts summary.
get
https://example.com/v2/alerts-summary
Get alerts summary grouped by category.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
RESPONSE
Click
Try It!
to start a request and see the response here!