Cohesity

Cohesity Helios REST API

Helios is Cohesity's SaaS-based control plane that manages a fleet of Cohesity clusters from a single global pane of glass. The Helios REST API authenticates via an apiKey generated from the Helios UI and passed in the request header, supports both v1 and v2 endpoint families, and lets customers list and operate registered clusters, run protection jobs, manage policies, and access reporting and analytics globally.

GitHub OpenAPI

Operations 263

Showing the first 250 of 263. The full set is in the contract, and via get_provider_operations.

GET /active-directories Get the list of Active Directories. #
POST /active-directories Create an Active Directory. #
GET /active-directories/{id} Get an Active Directory by id. #
PUT /active-directories/{id} Update an Active Directory. #
DELETE /active-directories/{id} Delete an Active Directory. #
GET /alertsSummary Get alerts summary. #
GET /audit-logs Get cluster audit logs. #
GET /audit-logs/actions Get cluster audit logs actions. #
GET /audit-logs/entity-types Get cluster audit logs entity types. #
GET /audit-logs/filer-configs Get filer audit log configs. #
PUT /audit-logs/filer-configs Update filer audit log configs. #
GET /chassis Get list of chassis #
GET /chassis/{id} Get a chassis by chassis id. #
PATCH /chassis/{id} Update a chassis by chassis id. #
POST /clientcsr Create Certificate Signing Requests on the cluster. #
POST /clientcsr/certificate Import the signed certificates on the cluster after the Certificate Signing Requests are created. #
GET /clusters Retrieve Cluster Configuration #
PUT /clusters Update a cluster. #
POST /clusters Create a cluster. #
GET /clusters/amqp-target-config Get AMQP Target Config #
PUT /clusters/amqp-target-config Update AMQP Target Config #
DELETE /clusters/amqp-target-config Delete AMQP Target Config #
GET /connection-bifrost Get connections of Bifrost on the cluster. #
POST /connection-bifrost Create a connection of Bifrost on the cluster. #
GET /connection-bifrost/{id} Get a connection of Bifrost by the id. #
PUT /connection-bifrost/{id} Update a connection of Bifrost. #
DELETE /connection-bifrost/{id} Delete a connection of Bifrost. #
GET /connection-rigel Get connections of Rigel on the cluster. #
POST /connection-rigel Create a connection of Rigel on the cluster. #
GET /connection-rigel/{id} Get a connection of Rigel by the id. #
PUT /connection-rigel/{id} Update a connection of Rigel. #
DELETE /connection-rigel/{id} Delete a connection of Rigel. #
GET /connector-hybrid-extender Get Bifrost connectors on the cluster. #
POST /connector-hybrid-extender Create a Bifrost connector on the cluster. #
GET /connector-hybrid-extender/{id} Get a Bifrost connector by the id. #
PUT /connector-hybrid-extender/{id} Update a Bifrost connector. #
DELETE /connector-hybrid-extender/{id} Delete a Bifrost connector. #
GET /connector-rigel Get Rigel connectors on the cluster. #
POST /connector-rigel Create a Rigel connector on the cluster. #
GET /connector-rigel/{id} Get a Rigel connector by the id. #
PUT /connector-rigel/{id} Update a Rigel connector. #
DELETE /connector-rigel/{id} Delete a Rigel connector. #
GET /csr List Certificate Signing Requests on the cluster. #
POST /csr Create a Certificate Signing Request on the cluster. #
POST /csr/certificate Update the signed certificate on the cluster after a Certificate Signing Request is created. #
GET /csr/{id} List the specified Certificate Signing Request. #
DELETE /csr/{id} Delete a Certificate Signing Request on the cluster. #
GET /data-protect/failover/pollPlannedRuns Get the list of failover planned runs. #
GET /data-protect/failover/views/{id} Get View Failover. #
POST /data-protect/failover/views/{id} Create View Failover Task. #
POST /data-protect/failover/views/{id}/cancel Cancel View Failover Task. #
POST /data-protect/failover/{id} Initiate a failover request. #
POST /data-protect/failover/{id}/backupActivation Activate failover entity backup on replication clsuter. #
POST /data-protect/failover/{id}/backupDeactivation Deactivate failover entity backup on source clsuter. #
POST /data-protect/failover/{id}/cancel Cancel failover workflow. #
POST /data-protect/failover/{id}/objectLinkage Linking between replicated objects and failover objects #
POST /data-protect/failover/{id}/plannedRun Create a planned run for backup and replication. #
POST /data-protect/filter/objects List all the filtered objects. #
GET /data-protect/objects Get Objects. #
POST /data-protect/objects/actions Actions on Objects #
GET /data-protect/objects/last-run Get last protection run of objects. #
POST /data-protect/objects/runs/cancel Cancel object runs. #
GET /data-protect/objects/{id} Get an Object. #
POST /data-protect/objects/{id}/actions Perform an action on an object. #
GET /data-protect/objects/{id}/pit-ranges Get PIT ranges for an object #
GET /data-protect/objects/{id}/runs Get the list of runs for an object. #
GET /data-protect/objects/{id}/runs/{runId} Get a run for an object. #
GET /data-protect/objects/{id}/snapshots List the snapshots for a given object. #
PUT /data-protect/objects/{id}/snapshots/{snapshotId} Update an object snapshot. #
GET /data-protect/objects/{id}/stats Get stats for a given object. #
GET /data-protect/objects/{id}/tree Get the objects tree hierarchy for for an Object. #
GET /data-protect/objects/{objectId}/indexed-objects/snapshots Get snapshots of indexed object. #
GET /data-protect/objects/{objectId}/protection-groups/{protectionGroupId}/indexed-objects/snapshots Get snapshots of indexed object. #
GET /data-protect/policies List Protection Policies based on provided filtering parameters. #
POST /data-protect/policies Create a Protection Policy. #
GET /data-protect/policies/{id} List details about a single Protection Policy. #
PUT /data-protect/policies/{id} Update a Protection Policy. #
DELETE /data-protect/policies/{id} Delete a Protection Policy. #
GET /data-protect/policy-templates List Policy Templates filtered by query parameters. #
GET /data-protect/policy-templates/{id} List details about a single Policy Template. #
POST /data-protect/protected-objects Create Object Backup. #
POST /data-protect/protected-objects/actions Perform Actions on Protect Objects. #
PUT /data-protect/protected-objects/{id} Update Object Backup. #
GET /data-protect/protection-groups Get the list of Protection Groups. #
POST /data-protect/protection-groups Create a Protection Group. #
POST /data-protect/protection-groups/states Perform an action like pause, resume, active, deactivate on all specified Protection Groups. #
GET /data-protect/protection-groups/{id} List details about single Protection Group. #
PUT /data-protect/protection-groups/{id} Update a Protection Group. #
DELETE /data-protect/protection-groups/{id} Delete a Protection Group. #
GET /data-protect/protection-groups/{id}/runs Get the list of runs for a Protection Group. #
PUT /data-protect/protection-groups/{id}/runs Update runs for a particular Protection Group. #
POST /data-protect/protection-groups/{id}/runs Create a new protection run. #
GET /data-protect/protection-groups/{id}/runs/{runId} Get a run for a Protection Group. #
POST /data-protect/protection-groups/{id}/runs/{runId}/cancel Cancel protection group run. #
GET /data-protect/protection-groups/{id}/runs/{runId}/debug-logs Get the debug logs for a run from a Protection Group. #
GET /data-protect/protection-groups/{id}/runs/{runId}/objects/{objectId}/debug-logs Get the debug logs for a particular object in a run from a Protection Group. #
GET /data-protect/protection-groups/{id}/runs/{runId}/objects/{objectId}/downloadMessages Get the CSV of errors/warnings for a given run and an object. #
GET /data-protect/recoveries Lists the Recoveries. #
POST /data-protect/recoveries Performs a Recovery. #
POST /data-protect/recoveries/downloadFilesAndFoldersRecovery Create a download files and folders recovery. #
GET /data-protect/recoveries/{id} Get Recovery for a given id. #
POST /data-protect/recoveries/{id}/cancel Cancel Recovery for a given id. #
GET /data-protect/recoveries/{id}/debug-logs Get the debug logs for a particular recovery operation. #
GET /data-protect/recoveries/{id}/downloadFiles Download files from the given download file recovery. #
POST /data-protect/recoveries/{id}/tearDown Tear down Recovery for a given id. #
GET /data-protect/runs/summary Get the list of runs. #
GET /data-protect/runs/{runId}/progress Get the progress of a run. #
POST /data-protect/search/indexed-objects List indexed objects. #
GET /data-protect/search/objects List Objects. #
GET /data-protect/search/protected-objects List Protected Objects. #
GET /data-protect/snapshots/{snapshotId} Get details of object snapshot. #
POST /data-protect/snapshots/{snapshotId}/metaInfo Construct meta info for any workflow from object snapshot and some other information. #
GET /data-protect/snapshots/{snapshotId}/volume Get volume info of object snapshot. #
GET /data-protect/snapshots/{snapshotsId}/downloadFile Download an indexed file. #
GET /data-protect/sources Get a List of Protection Sources. #
GET /data-protect/sources/filters List attribute filters for a source. #
GET /data-protect/sources/registrations Get the list of Protection Source registrations. #
POST /data-protect/sources/registrations Register a Protection Source. #
GET /data-protect/sources/registrations/{id} Get a Protection Source registration. #
PUT /data-protect/sources/registrations/{id} Update Protection Source registration. #
DELETE /data-protect/sources/registrations/{id} Delete Protection Source Registration. #
POST /data-protect/sources/test-connection Test connection to a source. #
GET /data-protect/sources/virtual-datacenter/{id} Get VDC Details. #
GET /data-protect/sources/{id} Get a Protection Sources. #
GET /data-protect/sources/{sourceId}/objects List objects on a source which can be used for data protection. #
GET /data-tiering/analysis-groups Get the list of data tiering analysis groups. #
POST /data-tiering/analysis-groups Create a data tiering analysis group. #
POST /data-tiering/analysis-groups/states Update data tiering analysis groups state. #
GET /data-tiering/analysis-groups/{id} Get data tiering analysis group by id. #
DELETE /data-tiering/analysis-groups/{id} Delete data tiering analysis group. #
PUT /data-tiering/analysis-groups/{id}/config Update data tiering analysis group config. #
POST /data-tiering/analysis-groups/{id}/runs Create a data tiering analysis group run. #
POST /data-tiering/analysis-groups/{id}/runs/{runId}/cancel Cancel data tiering analysis run. #
GET /data-tiering/tasks Get the list of data tiering tasks. #
POST /data-tiering/tasks Create a data tiering task. #
POST /data-tiering/tasks/states Update data tiering source analysis tasks state. #
GET /data-tiering/tasks/{id} Get data tiering task by id. #
PUT /data-tiering/tasks/{id} Update a data tiering task. #
DELETE /data-tiering/tasks/{id} delete the data tiering task. #
POST /data-tiering/tasks/{id}/runs Create a data tiering tasks run. #
POST /data-tiering/tasks/{id}/runs/{runId}/cancel Cancel data tiering task. #
POST /disks/assimilate Assimilate disks. #
GET /disks/discover Discover new disks #
POST /disks/identify Identify a disk #
GET /disks/local Get list of disks #
GET /disks/remote Get remote disks #
POST /disks/remote Add remote disk #
DELETE /disks/remote/{id} Remove remote disk #
POST /disks/{id}/remove Mark Disk for removal #
GET /dmaas-tenant-certificate Get DMaaS tenant certificates on the cluster. #
POST /dmaas-tenant-certificate Add a DMaaS tenant certificate to the cluster. #
DELETE /dmaas-tenant-certificate/{tenantId} Delete a tenant certificate. #
GET /domain-controllers Get Domain Controllers of specified domains. #
GET /file-services/view-template List View Templates #
POST /file-services/view-template Create a View Template #
GET /file-services/view-template/{id} Read a View Template by Id #
PUT /file-services/view-template/{id} Update a View Template #
DELETE /file-services/view-template/{id} Delete a View Template #
GET /file-services/views List Views #
POST /file-services/views Create a View #
GET /file-services/views/{id} Get a View by Id #
PUT /file-services/views/{id} Update a View #
DELETE /file-services/views/{id} Delete a View #
POST /fleet-env-info Update Fleet Env Info. #
POST /helios-registration Register to Helios. #
GET /helios-registration-config Lists the Helios Registration Config. #
GET /kerberos-providers Get the list of Kerberos Providers. #
POST /kerberos-providers/register Register a Kerberos Authentication Provider. #
POST /kerberos-providers/unregister/{id} Unregister a Kerberos Provider. #
GET /kerberos-providers/{id} Get the Registered Kerberos Provider by id. #
PUT /kerberos-providers/{id} Update the Kerberos Provider Registration. #
GET /keystones Get Keystones. #
POST /keystones Create a Keystone configuration. #
GET /keystones/{id} Get a Keystone by its id. #
PUT /keystones/{id} Update a Keystone configuration. #
DELETE /keystones/{id} Delete a Keystone configuration. #
GET /network-interfaces Get list of interfaces #
POST /networkReset Set or cancel cluster reset state. This is destructive operation. #
GET /networkReset/status List of nodes reset states. #
GET /nis-netgroups Get a list of NIS netgroups. #
POST /nis-netgroups Create an NIS netgroup. #
GET /nis-netgroups/{name} Get an NIS netgroup by name. #
PUT /nis-netgroups/{name} Update an NIS netgroup by name. #
DELETE /nis-netgroups/{name} Delete an NIS netgroup by name. #
GET /nis-providers Get a list of NIS Providers. #
POST /nis-providers Create an NIS Provider. #
GET /nis-providers/{domain} Get an NIS Provider by domain name. #
PUT /nis-providers/{domain} Update an NIS Provider by domain name. #
DELETE /nis-providers/{domain} Delete an NIS Provider by domain name. #
GET /nodeGroups List Node Groups based on provided filtering parameters. #
POST /nodeGroups Create a Node Group. #
GET /nodeGroups/{groupName} List Node Groups for a given Group Name. #
PUT /nodeGroups/{groupName} Update a Node Group. #
DELETE /nodeGroups/{groupName} Delete a Node Group. #
POST /nodePower Reboot or shutdown nodes in cluster. #
POST /nodes/{id}/identify Identify node #
POST /nodes/{id}/remove Mark Node for removal #
GET /patch-management/applied-patches Get applied patches #
POST /patch-management/applied-patches Revert patches #
GET /patch-management/available-patches Get available patches #
PUT /patch-management/available-patches Import patches #
POST /patch-management/available-patches Apply patches #
GET /patch-management/operation-status Get patch operation status #
GET /patch-management/patches-history Get patches history #
GET /racks Get list of racks #
POST /racks Create racks #
DELETE /racks Delete all the racks. #
PATCH /racks Update racks #
GET /racks/{id} Get a rack by rack id. #
DELETE /racks/{id} Delete a rack by id. #
PATCH /racks/{id} #
POST /refresh-bulletin-board Refresh bulletin board from Helios. #
GET /remote-storage Get Registered Remote Storage Servers List #
POST /remote-storage Register Remote Storage #
GET /remote-storage/{id} Get remote storage details #
DELETE /remote-storage/{id} Delete Remote Storage Registration #
PATCH /remote-storage/{id} Update Remote Storage Config #
GET /rigel-claim-logs Lists the claim logs for rigel. #
GET /security-config Get cluster security settings. #
PUT /security-config Update cluster security settings. #
GET /security-principals Get Security Principals. #
GET /security/ciphers Gets the list of ciphers enabled on the cluster. #
POST /security/ciphers Enable/Disable a list of ciphers on the cluster. Iris must be restarted for the change to take effect. #
GET /stats/protection-runs Get statistics of protection runs. #
DELETE /storage-domains/{id} Delete a Storage Domain. #
GET /support-channel-config Get support channel configuration. #
PUT /support-channel-config Update support channel configuration. #
GET /syslogAuditTags Get cluster audit tags. #
POST /syslogAuditTags Update cluster audit tags. #
GET /syslogProgramNames Get supported program names. #
GET /syslogs Get list of syslog servers. #
POST /syslogs Add Syslog Server #
DELETE /syslogs Remove syslog servers #
GET /syslogs/{id} Get a syslog server by id. #
PUT /syslogs/{id} Update a syslog server by id. #
DELETE /syslogs/{id} Remove syslog server by id #
PATCH /syslogs/{id} Patch a syslog server by id. #
GET /syslogs/{id}/status Get a syslog server reachability status. #
GET /tags Get tags based on filters. #
POST /tags Create a Tag #
GET /tags/{id} Get Tag by id. #
PUT /tags/{id} Update a Tag #
DELETE /tags/{id} Delete a Tag #
GET /tasks Get tasks details. #
GET /tdm/objects Get all TDM objects #
GET /tdm/objects/{id} Get TDM object by ID #
GET /tdm/objects/{id}/timeline-events Get timeline events of object #
PUT /tdm/snapshots/{id} Update a snapshot by ID #
DELETE /tdm/snapshots/{id} Delete a snapshot by ID #
GET /tdm/tasks Get all TDM tasks #

Documentation

📖
Documentation
https://developer.cohesity.com/helios-api.html
📖
GettingStarted
https://developer.cohesity.com/docs/helios-getting-started
📖
APIReference
https://developer.cohesity.com/apidocs/versions/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cohesity/refs/heads/main/openapi/cohesity-cluster-v2-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cohesity/refs/heads/main/openapi/_original/cohesity-cluster-v2-openapi-original.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/cohesity/refs/heads/main/overlays/cohesity-cluster-v2-overlay.yaml
🔗
Postman
https://api.cohesity.com/
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/cohesity/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/helios-rest-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cohesity-cluster-v2-openapi.yml Raw ↑ 
consumes:
- application/json
produces:
- application/json
schemes:
- https
swagger: '2.0'
info:
  description: Cohesity API provides a RESTful interface to access the various data
    management operations on Cohesity cluster and Helios.
  title: Cohesity REST API
  version: '2.0'
basePath: /v2
paths:
  /active-directories:
    get:
      description: Get the list of Active Directories.
      tags:
      - ActiveDirectory
      summary: Get the list of Active Directories.
      operationId: GetActiveDirectory
      parameters:
      - type: array
        items:
          pattern: ^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9])(\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]{0,61}[a-zA-Z0-9]))*$
          type: string
        description: Filter by a list of Active Directory domain names.
        name: domainNames
        in: query
      - type: array
        items:
          type: integer
          format: int64
        description: Filter by a list of Active Directory Ids.
        name: ids
        in: query
      - type: array
        items:
          type: string
        description: TenantIds contains ids of the tenants for which objects are to
          be returned.
        name: tenantIds
        in: query
      - type: boolean
        description: If true, the response will include Protection Groups which were
          created by all tenants which the current user has permission to see. If
          false, then only Protection Groups created by the current user will be returned.
        name: includeTenants
        in: query
      responses:
        '200':
          $ref: '#/responses/GetActiveDirectoriesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: &id001
      - APIKeyHeader: []
    post:
      description: Create an Active Directory.
      tags:
      - ActiveDirectory
      summary: Create an Active Directory.
      operationId: CreateActiveDirectory
      parameters:
      - description: Specifies the parameters to create an Active Directory.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateActiveDirectoryRequest'
      responses:
        '201':
          $ref: '#/responses/CreateOrUpdateActiveDirectoryResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /active-directories/{id}:
    get:
      description: Get an Active Directory by id.
      tags:
      - ActiveDirectory
      summary: Get an Active Directory by id.
      operationId: GetActiveDirectoryById
      parameters:
      - type: integer
        format: int64
        description: Specifies id of an Active Directory.
        name: id
        in: path
        required: true
      - type: boolean
        description: Specifies whether to include Centrify Zones of the Active Directory
          in response.
        name: includeCentrifyZones
        in: query
      - type: boolean
        description: Specifies whether to include Domain Controllers of the Active
          Directory in response.
        name: includeDomainControllers
        in: query
      - type: boolean
        description: Specifies whether to include Security Principals of the Active
          Directory in response.
        name: includeSecurityPrincipals
        in: query
      - type: string
        description: Specifies a prefix, only security principals with name or sAMAccountName
          having this prefix (ignoring cases) will be returned. This field is appliciable
          and mandatory if 'includeSecurityPrincipals' is set to true.
        name: prefix
        in: query
      - uniqueItems: true
        type: array
        items:
          enum:
          - User
          - Group
          - Computer
          - WellKnownPrincipal
          type: string
        description: Specifies a list of object classes, only security principals
          with object class in this list will be returned. This field is appliciable
          if 'includeSecurityPrincipals' is set to true.
        name: objectClass
        in: query
      responses:
        '200':
          $ref: '#/responses/GetActiveDirectoryByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update an Active Directory.
      tags:
      - ActiveDirectory
      summary: Update an Active Directory.
      operationId: UpdateActiveDirectory
      parameters:
      - type: integer
        format: int64
        description: Specifies id of an Active Directory.
        name: id
        in: path
        required: true
      - description: Request to update an Active Directory.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateActiveDirectoryRequest'
      responses:
        '200':
          $ref: '#/responses/UpdateActiveDirectoryResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete an Active Directory.
      tags:
      - ActiveDirectory
      summary: Delete an Active Directory.
      operationId: DeleteActiveDirectory
      parameters:
      - type: integer
        format: int64
        description: Specifies id of an Active Directory.
        name: id
        in: path
        required: true
      - type: string
        description: Specifies the username of the Active Direcotry Admin.
        name: activeDirectoryAdminUsername
        in: header
        required: true
      - type: string
        description: Specifies the password of the Active Direcotry Admin.
        name: activeDirectoryAdminPassword
        in: header
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /alertsSummary:
    get:
      description: Get alerts summary grouped by category.
      tags:
      - Platform
      summary: Get alerts summary.
      operationId: GetAlertSummary
      parameters:
      - type: integer
        format: int64
        description: Filter by start time. Specify the start time as a Unix epoch
          Timestamp (in microseconds). By default it is current time minus a day.
        name: startTimeUsecs
        in: query
      - type: integer
        format: int64
        description: Filter by end time. Specify the end time as a Unix epoch Timestamp
          (in microseconds). By default it is current time.
        name: endTimeUsecs
        in: query
      - type: boolean
        x-nullable: true
        description: 'IncludeTenants specifies if alerts of all the tenants under
          the

          hierarchy of the logged in user''s organization should be used to

          compute summary.'
        name: includeTenants
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: 'TenantIds contains ids of the tenants for which alerts are to
          be

          used to compute summary.'
        name: tenantIds
        in: query
      - type: array
        items:
          enum:
          - kResolved
          - kOpen
          - kNote
          - kSuppressed
          type: string
        x-nullable: true
        description: 'Specifies list of alert states to filter alerts by. If not specified,

          only open alerts will be used to get summary.'
        name: statesList
        in: query
      responses:
        '200':
          $ref: '#/responses/GetAlertsSummary'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /audit-logs:
    get:
      description: Get a cluster audit logs.
      tags:
      - AuditLog
      summary: Get cluster audit logs.
      operationId: GetAuditLogs
      parameters:
      - type: string
        x-nullable: true
        description: Search audit logs by 'entityName' or 'details'.
        name: searchString
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: Specifies a list of usernames, only audit logs made by these
          users will be returned.
        name: usernames
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: Specifies a list of domains, only audit logs made by user in
          these domains will be returned.
        name: domains
        in: query
      - type: array
        items:
          enum:
          - ClusterPartition
          - StorageDomain
          - View
          - Share
          - Node
          - Disk
          - Cluster
          - Vlan
          - User
          - ApiKey
          - Chassis
          - SslCertificate
          - ProtectionGroup
          - Source
          - RecoveryTask
          - SmtpServer
          - EncryptionKey
          - ProtectionPolicy
          - Alert
          - Resolution
          - AlertNotificationRule
          - Vault
          - RemoteCluster
          - ActiveDirectory
          - KerberosProvider
          - Ldap
          - AntivirusServiceGroup
          - InfectedFile
          - PreferredDomainController
          - Group
          - Role
          - ProtectionRun
          - SearchJob
          - PhysicalAgent
          - CloneTask
          - CloneRefreshTask
          - Network
          - Interface
          - NetworkInerfaceGroup
          - Scheduler
          - ProxyServer
          - StaticRoute
          - Ip
          - Qos
          - KmsConfiguration
          - CloudSpin
          - Tenant
          - IdpConfiguration
          - App
          - HeliosEvent
          - Object
          - ClusterServices
          - AccessToken
          - SnmpConfig
          - IoTier
          - ServiceFlag
          - SupportServer
          - Csr
          - Keystone
          - SwiftRoles
          - Tags
          - Nis
          - Snapshot
          - HybridExtender
          - DataTieringAnalysisGroup
          - DataTieringDowntierTask
          - DataTieringUptierTask
          - TrustedCA
          - AMQPTargetConfiguration
          - Patch
          - Hotfix
          type: string
        x-nullable: true
        description: Specifies a list of entity types, only audit logs containing
          these entity types will be returned.
        name: entityTypes
        in: query
      - type: array
        items:
          enum:
          - Login
          - Logout
          - Create
          - Modify
          - Delete
          - Activate
          - Deactivate
          - Pause
          - Resume
          - RunNow
          - Clone
          - Recover
          - Cancel
          - Register
          - Unregister
          - Update
          - Refresh
          - Upgrade
          - Upload
          - Download
          - Rename
          - Accept
          - Mark
          - Close
          - Join
          - DisJoin
          - Overwrite
          - MarkRemoval
          - CloudSpin
          - Assign
          - Unassign
          - NotificationRule
          - ScheduleReport
          - Install
          - Uninstall
          - Stop
          - Start
          - Restart
          - RunDiagnostics
          - Apply
          - Revert
          - Import
          - Validate
          type: string
        x-nullable: true
        description: Specifies a list of actions, only audit logs containing these
          actions will be returned.
        name: actions
        in: query
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies a unix timestamp in microseconds, only audit logs made
          after this time will be returned.
        name: startTimeUsecs
        in: query
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies a unix timestamp in microseconds, only audit logs made
          before this time will be returned.
        name: endTimeUsecs
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: Specifies a list of tenant ids, only audit logs made by these
          tenants will be returned.
        name: tenantIds
        in: query
      - type: boolean
        x-nullable: true
        description: If true, the response will include Protection Groups which were
          created by all tenants which the current user has permission to see. If
          false, then only Protection Groups created by the current user will be returned.
        name: includeTenants
        in: query
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies a start index. The oldest logs before this index will
          skipped, only audit logs from this index will be fetched.
        name: startIndex
        in: query
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the number of indexed obejcts to be fetched from the
          specified start index.
        name: count
        in: query
      responses:
        '200':
          $ref: '#/responses/GetAuditLogsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /audit-logs/actions:
    get:
      description: Get all actions of cluster audit logs.
      tags:
      - AuditLog
      summary: Get cluster audit logs actions.
      operationId: GetAuditLogsActions
      responses:
        '200':
          $ref: '#/responses/GetAuditLogsActionsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /audit-logs/entity-types:
    get:
      description: Get all entity types of cluster audit logs.
      tags:
      - AuditLog
      summary: Get cluster audit logs entity types.
      operationId: GetAuditLogsEntityTypes
      responses:
        '200':
          $ref: '#/responses/GetAuditLogsEntityTypesResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /audit-logs/filer-configs:
    get:
      description: Get filer audit log configs.
      tags:
      - AuditLog
      summary: Get filer audit log configs.
      operationId: GetFilerAuditLogConfigs
      responses:
        '200':
          $ref: '#/responses/GetFilerAuditLogConfigsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update filer audit log configs.
      tags:
      - AuditLog
      summary: Update filer audit log configs.
      operationId: UpdateFilerAuditLogConfigs
      parameters:
      - description: Specifies the filer audit log config to update.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/FilerAuditLogConfigs'
      responses:
        '200':
          $ref: '#/responses/GetFilerAuditLogConfigsResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /chassis:
    get:
      description: Get list of all chassis info that are part of cluster.
      tags:
      - Platform
      summary: Get list of chassis
      operationId: GetChassis
      parameters:
      - type: boolean
        description: Filters chassis that have no rack assigned.
        name: noRackAssigned
        in: query
      responses:
        '200':
          $ref: '#/responses/ChassisListResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /chassis/{id}:
    get:
      description: Get a chassis info by id.
      tags:
      - Platform
      summary: Get a chassis by chassis id.
      operationId: GetChassisById
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of chassis.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/ChassisResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    patch:
      description: Update selected properties of chassis info by id.
      tags:
      - Platform
      summary: Update a chassis by chassis id.
      operationId: UpdateChassisById
      parameters:
      - type: integer
        format: int64
        description: Specifies the id of chassis.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update chassis.
        name: body
        in: body
        schema:
          $ref: '#/definitions/Chassis'
      responses:
        '200':
          $ref: '#/responses/ChassisResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /clientcsr:
    post:
      description: Create two Certificate Signing Request on the cluster with the
        given details one each for client and server. Each service can have at most
        one outstanding pair of CSR.
      tags:
      - Security
      summary: Create Certificate Signing Requests on the cluster.
      operationId: CreateClientcsr
      parameters:
      - description: Specifies the parameters to create the Certificate Signing Requests.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateCsrRequest'
      responses:
        '201':
          $ref: '#/responses/CreateClientcsrResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /clientcsr/certificate:
    post:
      description: Import the signed certificates on the cluster after the Certificate
        Signing Requests are created.
      tags:
      - Security
      summary: Import the signed certificates on the cluster after the Certificate
        Signing Requests are created.
      operationId: ImportCertificateByClientcsr
      parameters:
      - description: Specifies the parameters to import the certificate.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ImportCertificateByClientcsrRequest'
      responses:
        '200':
          $ref: '#/responses/ImportCertificateByClientcsrResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /clusters:
    get:
      description: Retrieve some summary information about the Cluster Configuration.
      tags:
      - Platform
      summary: Retrieve Cluster Configuration
      operationId: GetCluster
      responses:
        '200':
          $ref: '#/responses/ClusterResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update the Cluster with the given configuration.
      tags:
      - Platform
      summary: Update a cluster.
      operationId: UpdateCluster
      parameters:
      - description: Specifies the parameters to update cluster.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/Cluster'
      responses:
        '200':
          $ref: '#/responses/ClusterResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a cluster with given network and cluster configuration.
      tags:
      - Platform
      summary: Create a cluster.
      operationId: CreateCluster
      parameters:
      - description: Specifies the parameters to create cluster.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateClusterParams'
      responses:
        '201':
          $ref: '#/responses/ClusterResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /clusters/amqp-target-config:
    get:
      description: Fetch AMQP target config on the cluster.
      tags:
      - Platform
      summary: Get AMQP Target Config
      operationId: GetAMQPTargetConfig
      responses:
        '200':
          $ref: '#/responses/ClusterAMQPTargetConfigResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Updates AMQP target config on the cluster.
      tags:
      - Platform
      summary: Update AMQP Target Config
      operationId: UpdateAMQPTargetConfig
      parameters:
      - description: Specifies the parameters to update cluster AMQP target config.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/ClusterAMQPTargetConfig'
      responses:
        '200':
          $ref: '#/responses/ClusterAMQPTargetConfigResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete AMQP target config on the cluster.
      tags:
      - Platform
      summary: Delete AMQP Target Config
      operationId: DeleteAMQPTargetConfig
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connection-bifrost:
    get:
      description: Get connections of Bifrost on the cluster.
      tags:
      - ExternalConnection
      summary: Get connections of Bifrost on the cluster.
      operationId: GetBifrostConnection
      parameters:
      - type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        description: Specifies the id of the connections.
        name: ids
        in: query
      - type: string
        x-nullable: true
        description: Specifies the id of the tenant which the connection belongs to.
        name: tenantId
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: Specifies the name of the connections.
        name: names
        in: query
      responses:
        '200':
          $ref: '#/responses/GetBifrostConnectionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a connection of Bifrost on the cluster.
      tags:
      - ExternalConnection
      summary: Create a connection of Bifrost on the cluster.
      operationId: CreateBifrostConnection
      parameters:
      - description: Specifies the parameters to create a connection.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateOrUpdateBifrostConnectionRequest'
      responses:
        '201':
          $ref: '#/responses/CreateOrUpdateBifrostConnectionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connection-bifrost/{id}:
    get:
      description: Get a connection of Bifrost by the id.
      tags:
      - ExternalConnection
      summary: Get a connection of Bifrost by the id.
      operationId: GetBifrostConnectionById
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of the Bifrost connection.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetBifrostConnectionByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update a connection of Bifrost.
      tags:
      - ExternalConnection
      summary: Update a connection of Bifrost.
      operationId: UpdateBifrostConnection
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of a Bifrost connection.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update a connection.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateOrUpdateBifrostConnectionRequest'
      responses:
        '200':
          $ref: '#/responses/CreateOrUpdateBifrostConnectionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete a connection of Bifrost.
      tags:
      - ExternalConnection
      summary: Delete a connection of Bifrost.
      operationId: DeleteBifrostConnection
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of a Bifrost connection.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connection-rigel:
    get:
      description: Get connections of Rigel on the cluster.
      tags:
      - ExternalConnection
      summary: Get connections of Rigel on the cluster.
      operationId: GetRigelConnection
      parameters:
      - type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        description: Specifies the id of the connections.
        name: ids
        in: query
      - type: string
        x-nullable: true
        description: Specifies the id of the tenant which the connection belongs to.
        name: tenantId
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: Specifies the name of the connection.
        name: names
        in: query
      responses:
        '200':
          $ref: '#/responses/GetRigelConnectionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a connection of Rigel on the cluster.
      tags:
      - ExternalConnection
      summary: Create a connection of Rigel on the cluster.
      operationId: CreateRigelConnection
      parameters:
      - description: Specifies the parameters to create a connection.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateRigelConnectionRequest'
      responses:
        '201':
          $ref: '#/responses/CreateOrUpdateRigelConnectionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connection-rigel/{id}:
    get:
      description: Get a connection of Rigel by the id.
      tags:
      - ExternalConnection
      summary: Get a connection of Rigel by the id.
      operationId: GetRigelConnectionById
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of the Rigel connection.
        name: id
        in: path
        required: true
      responses:
        '200':
          $ref: '#/responses/GetRigelConnectionByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update a connection of Rigel.
      tags:
      - ExternalConnection
      summary: Update a connection of Rigel.
      operationId: UpdateRigelConnection
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of the Rigel connection.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update the connection.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UpdateRigelConnectionRequest'
      responses:
        '200':
          $ref: '#/responses/CreateOrUpdateRigelConnectionResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete a connection of Rigel.
      tags:
      - ExternalConnection
      summary: Delete a connection of Rigel.
      operationId: DeleteRigelConnection
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of the Rigel connection.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connector-hybrid-extender:
    get:
      description: Get Bifrost connectors on the cluster.
      tags:
      - Connectors
      summary: Get Bifrost connectors on the cluster.
      operationId: GetBifrostConnector
      parameters:
      - type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        description: Specifies the id of the connectors.
        name: ids
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: Specifies the name of the connectors.
        name: names
        in: query
      - type: string
        x-nullable: true
        description: Specifies the id of the tenant which the connector belongs to.
        name: tenantId
        in: query
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the Id of the connection which the connector belongs
          to.
        name: connectionId
        in: query
      responses:
        '200':
          $ref: '#/responses/GetBifrostConnectorResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    post:
      description: Create a Bifrost connector on the cluster.
      tags:
      - Connectors
      summary: Create a Bifrost connector on the cluster.
      operationId: CreateBifrostConnector
      parameters:
      - description: Specifies the parameters to create a connector.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateOrUpdateBifrostConnectorRequest'
      responses:
        '201':
          $ref: '#/responses/CreateOrUpdateBifrostConnectorResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connector-hybrid-extender/{id}:
    get:
      description: Get a Bifrost connector by the id.
      tags:
      - Connectors
      summary: Get a Bifrost connector by the id.
      operationId: GetBifrostConnectorById
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of connector.
        name: id
        in: path
        required: true
      - type: string
        x-nullable: true
        description: Specifies the id of the tenant which the connector belongs to.
        name: tenantId
        in: query
      responses:
        '200':
          $ref: '#/responses/GetBifrostConnectorByIdResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    put:
      description: Update a Bifrost connector.
      tags:
      - Connectors
      summary: Update a Bifrost connector.
      operationId: UpdateBifrostConnector
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of connector.
        name: id
        in: path
        required: true
      - description: Specifies the parameters to update a connector.
        name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/CreateOrUpdateBifrostConnectorRequest'
      responses:
        '200':
          $ref: '#/responses/CreateOrUpdateBifrostConnectorResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
    delete:
      description: Delete a Bifrost connector.
      tags:
      - Connectors
      summary: Delete a Bifrost connector.
      operationId: DeleteBifrostConnector
      parameters:
      - type: integer
        format: int64
        x-nullable: true
        description: Specifies the id of connector.
        name: id
        in: path
        required: true
      responses:
        '204':
          $ref: '#/responses/NoContentResponse'
        default:
          $ref: '#/responses/ErrorResponse'
      security: *id001
  /connector-rigel:
    get:
      description: Get Rigel connectors on the cluster.
      tags:
      - Connectors
      summary: Get Rigel connectors on the cluster.
      operationId: GetRigelConnector
      parameters:
      - type: array
        items:
          type: integer
          format: int64
        x-nullable: true
        description: Specifies the id of the connector.
        name: ids
        in: query
      - type: array
        items:
          type: string
        x-nullable: true
        description: Specifies the name of the connectors.
        name: names
        in: query
      - type: string
        x-nullable: true
        description: Specifies the id of the tenant

# --- truncated at 32 KB (1826 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cohesity/refs/heads/main/openapi/cohesity-cluster-v2-openapi.yml