Commvault Alerts API

openapi: 3.1.0
info:
  title: Commvault Automation Agents Alerts 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: Alerts
  description: Manage alerts and notification configurations
paths:
  /AlertRule:
    get:
      operationId: listAlerts
      summary: Commvault List alert rules
      description: Retrieves a list of configured alert rules. Alerts notify administrators of important events such as job failures, storage thresholds, and security events.
      tags:
      - Alerts
      responses:
        '200':
          description: List of alert rules
          content:
            application/json:
              schema:
                type: object
                properties:
                  alertList:
                    type: array
                    items:
                      $ref: '#/components/schemas/Alert'
        '401':
          description: Unauthorized
components:
  schemas:
    Alert:
      type: object
      properties:
        id:
          type: integer
          description: Unique alert identifier
        name:
          type: string
          description: Alert rule name
        alertType:
          type: integer
          description: Type of alert
        severity:
          type: string
          description: Alert severity level
          enum:
          - Information
          - Warning
          - Critical
        criteria:
          type: object
          description: Conditions that trigger the alert
  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