How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cohesity Helios Reporting API

The Helios Reporting service exposes Cohesity's cross-cluster reporting layer as a standalone REST API with 20 operations. It publishes a catalog of report types and their components, renders on-demand previews without persisting anything, and manages recurring schedules whose exports are collected as downloadable task artifacts. Authentication is the same apiKey header used across the Cohesity surface.

Cohesity Helios Reporting API is one of 4 APIs that Cohesity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reporting, Analytics, Helios, and Automation. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 20 operations across 17 paths, organized into 6 resource areas, and defines 64 schemas. It is described by OpenAPI 2.0, at version v1.

Requests are made against the base URL https://helios.cohesity.com/heliosreporting/api/v1.

20 operations 17 paths 64 schemas 1 DELETE10 GET8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v1
Base URL
https://helios.cohesity.com/heliosreporting/api/v1
Authentication
API Key
Terms of Service
Resource Areas
6

Authentication & Security 1

Cohesity Helios Reporting API declares 1 security scheme for authenticating requests. An API key is passed in the header as apiKey (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 20

Across 17 paths, the API surfaces 20 operations — 1 DELETE, 10 GET, 8 POST, 1 PUT. They span 6 resource areas: Components, Reports, Schedules, Tasks, Artifacts, Filters. Each is listed below with its method, path, parameters, and response codes.

Components 4
GET
/public/components
List Report Components
GetComponents 1 param → 200default
GET
/public/components/{id}
Fetch a Report Component
GetComponentById 1 param → 200default
POST
/public/components/preview
Fetch Preview of components.
GetComponentsPreview 1 param → 200default
POST
/public/components/{id}/preview
Fetch Preview of a component.
GetComponentPreview 2 params → 200default
Reports 5
GET
/public/reports/report-types/{reportType}
List properties of a report type
GetReportType 1 param → 200default
GET
/public/reports
List Reports
GetReports 2 params → 200default
GET
/public/reports/{id}
Fetch a Report
GetReportById 1 param → 200default
POST
/public/reports/{id}/preview
Fetch a Report Preview
GetReportPreview 2 params → 200default
POST
/public/reports/{id}/export
Export a Report
ExportReport 2 params → 200default
Schedules 7
GET
/public/schedules
List all schedules.
GetSchedules 5 params → 200default
POST
/public/schedules
Create a Schedule
CreateSchedule 1 param → 200default
GET
/public/schedules/{id}
Fetch a Schedule
GetScheduleById 1 param → 200default
PUT
/public/schedules/{id}
Update a Schedule
UpdateSchedule 2 params → 200default
DELETE
/public/schedules/{id}
Delete a Schedule
DeleteSchedule 1 param → 204default
POST
/public/schedules/{id}/run
Run a schedule on demand.
RunScheduleOnDemand 1 param → 204default
POST
/public/schedules/state
Update Schedules State
UpdateSchedulesState 1 param → 200default
Tasks 2
GET
/public/tasks
Fetch Tasks
GetTasks 7 params → 200default
GET
/public/tasks/{id}
Fetch a Task
GetTaskById 1 param → 200default
Artifacts 1
GET
/public/artifacts/{taskId}/{format}
Fetch report artifact for task
GetArtifactForTask 2 params → 200default
Filters 1
POST
/public/resources
Get resources
GetResources 1 param → 200default

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are Task (15 properties), Schedule (14 properties), Component (10 properties), AttributeFilter (7 properties). Each schema is shown below with its type and property counts.

ReportType
string
AggregationType
string
DataType
string
ReportCategoryEnum
string
TaskStatusEnum
string
ReportFormatEnum
string
FileTypeEnum
string
CompressionType
string
ScheduleStateEnum
string
FilterType
string
ReportContextEnum
string
DataFormatType
string
DateRangeType
string
ResourceType
string
Components
object
Specifies a list of report components.
1 property
Component
object
Specifies a Report Component.
10 properties
CustomConfigParams
object
Specifies the configuration parameters to customize and format the columns in the report artifacts like excel, pdf etc
1 property
XlsxCustomConfigParams
object
Specifies the configuration parameters to customize a component in excel report.
1 property
XlsxAttributeCustomConfigParams
object
Specifies the configuration parameters to customize the columns in excel report for a component. The ordering of the columns in the resulting xlsx will be done…
3 properties 1 required
AttributeSort
object
Specifies the sorting (ordering) parameters to be applied to the resulting data.
2 properties 1 required
LimitParams
object
Specifies the parameters to limit the resulting dataset.
2 properties 1 required
ComponentPreviewParams
object
Specifies preview of a component.
4 properties
ComponentPreview
object
Specifies preview of a component.
4 properties
ComponentsPreviewParams
object
Specifies preview of a component.
3 properties
ComponentsPreview
object
Specifies preview of a component.
4 properties
Reports
object
Specifies a list of Reports.
1 property
Report
object
Specifies a Report.
6 properties
ReportPreviewParams
object
Specifies preview of a Report.
3 properties
ReportPreview
object
Specifies preview of a Report.
6 properties
ExportReportParams
object
Parameters for exporting a report.
5 properties
ExportReportResp
object
Response for exporting a report.
1 property
ScheduleTimeParams
object
Specifies the time parameters of a schedule for a report.
5 properties 1 required
Schedules
object
Specifies a list of Schedules.
1 property
Schedule
object
Definition of a Schedule for a report.
14 properties 2 required
UpdateSchedulesStateRequest
object
Definition to update schedules state.
2 properties 1 required
UpdateSchedulesState
object
Response of update schedules state call.
2 properties
FailedScheduleDetails
object
Specifies the schedule that failed to update along with error.
2 properties
SchedulesDao
object
Specifies a list of ScheduleDao.
1 property
ScheduleDao
object
"Definition of a schedule dao for store. ScheduleDao stands for schedule data access object. It is stored as is in mongoDb"
TasksDao
object
Specifies a list of TasksDao.
1 property
TaskDao
object
"Definition of a task dao for store. TaskDao stands for task data access object. It is stored as is in mongoDb"
Tasks
object
Specifies a list of tasks.
1 property
Task
object
Definition of a task.
15 properties 1 required
Artifact
object
Specifies format and link to the artifacts
3 properties
InFilterParams
object
Specifies the in filter that are applied on attributes.
6 properties 1 required
RangeFilterParams
object
Specifies the filters that are applied on attributes.
2 properties
TimeRangeFilterParams
object
Specifies the time range filter. Specifying this will pre filter all the results on necessary resources like Protection Runs etc before applying aggregations.…
4 properties
SystemsFilterParams
object
Specifies the systems filter. Specifying this will pre filter all the results provided list of system identifier before applying aggregations.
2 properties 1 required
TenantsFilterParams
object
Specifies the tenants filter. Specifying this will pre filter all the results with provided list of tenants before applying aggregations.
3 properties
AttributeFilter
object
Specifies the filters that are applied on attributes.
7 properties 2 required
AttributeAggregations
object
Specifies the aggregation related information that needs to be applied on the attributes.
2 properties
AggregatedAttributesParams
object
Specifies list of aggregation properties to be applied on the attributes.
3 properties 2 required
ReportTypeAttributes
object
Specifies list of attributes and properties for a given report type.
1 property
ReportTypeAttribute
object
Specifies an attribute and its properties for a given report type.
2 properties
KafkaMessage
object
The kafka message which is picked up by the helper.
4 properties
GetResourcesRequest
object
Specifies the request parameters to fetch resources.
1 property 1 required
Resources
object
Specifies the resources response.
7 properties
ExternalTarget
object
Specifies an External target.
5 properties
ProtectionGroup
object
Specifies the Protection Group resource.
4 properties
RegisteredSource
object
Specifies the Registered Source resource.
3 properties
Policy
object
Specifies the Protection Policy resource.
5 properties
MessageCodeMapping
object
Specifies an error code and GUID.
2 properties
Error
object
Specifies the error object with error code and a message.
2 properties
Tenant
object
Specifies the Tenant resource.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cohesity-helios-reporting-openapi.yml Raw ↑

Other APIs Cohesity publishes across the network.

Cohesity Helios REST API
Cohesity DataProtect REST API
Cohesity Site Continuity API
Where this information came from

This is an independent, third-party profile of Cohesity Helios Reporting API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.