Commvault Reports API

openapi: 3.1.0
info:
  title: Commvault Automation Agents Reports API
  description: API for automating Commvault workflows, job scheduling, and policy management. Enables programmatic creation and execution of custom workflows, management of schedule policies, and configuration of automated operations for data protection environments.
  version: v2
  contact:
    name: Commvault Support
    url: https://www.commvault.com/support
  termsOfService: https://www.commvault.com/terms-of-use
servers:
- url: https://{webserver}/webconsole/api
  description: Commvault Web Server
  variables:
    webserver:
      default: webconsole.example.com
      description: Hostname of the Commvault Web Server
security:
- authToken: []
tags:
- name: Reports
  description: Reporting and analytics
paths:
  /Reports:
    get:
      operationId: listReports
      summary: Commvault List available reports
      description: Retrieves a list of all available reports, including built-in and custom reports for backup, storage, compliance, and operational analytics.
      tags:
      - Reports
      responses:
        '200':
          description: List of reports
          content:
            application/json:
              schema:
                type: object
                properties:
                  reports:
                    type: array
                    items:
                      $ref: '#/components/schemas/Report'
        '401':
          description: Unauthorized
  /Reports/{reportId}:
    get:
      operationId: getReport
      summary: Commvault Get report data
      description: Executes a specific report and returns the report data, including charts, tables, and summary statistics.
      tags:
      - Reports
      parameters:
      - $ref: '#/components/parameters/reportId'
      - name: timeRange
        in: query
        required: false
        description: Time range for the report
        schema:
          type: string
      responses:
        '200':
          description: Report data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Report'
        '401':
          description: Unauthorized
        '404':
          description: Report not found
components:
  parameters:
    reportId:
      name: reportId
      in: path
      required: true
      description: Unique identifier for the report
      schema:
        type: integer
  schemas:
    Report:
      type: object
      properties:
        reportId:
          type: integer
          description: Unique report identifier
        reportName:
          type: string
          description: Name of the report
        reportCategory:
          type: string
          description: Category of the report
          enum:
          - Backup
          - Storage
          - SLA
          - Compliance
          - Operational
          - Custom
        description:
          type: string
          description: Description of the report
  securitySchemes:
    authToken:
      type: apiKey
      in: header
      name: Authtoken
      description: QSDK authentication token obtained from the Login endpoint.
externalDocs:
  description: Commvault Automation API Documentation
  url: https://documentation.commvault.com/v11/essential/rest_api_automation.html