Commvault Policies API

openapi: 3.1.0
info:
  title: Commvault Automation Agents Policies 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: Policies
  description: Manage data protection policies
paths:
  /V4/CommcellGlobalFilter:
    get:
      operationId: getGlobalFilters
      summary: Commvault Get global data protection filters
      description: Retrieves the global exclusion filters applied to all backup operations, such as temporary file patterns, operating system cache directories, and other commonly excluded content.
      tags:
      - Policies
      responses:
        '200':
          description: Global filters
          content:
            application/json:
              schema:
                type: object
                properties:
                  globalFiltersInfo:
                    type: object
                    properties:
                      windowsFilters:
                        type: array
                        items:
                          type: string
                      unixFilters:
                        type: array
                        items:
                          type: string
        '401':
          description: Unauthorized
    put:
      operationId: updateGlobalFilters
      summary: Commvault Update global data protection filters
      description: Updates the global exclusion filters for backup operations.
      tags:
      - Policies
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                globalFiltersInfo:
                  type: object
                  properties:
                    windowsFilters:
                      type: array
                      items:
                        type: string
                    unixFilters:
                      type: array
                      items:
                        type: string
      responses:
        '200':
          description: Global filters updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
components:
  schemas:
    GenericResponse:
      type: object
      properties:
        errorCode:
          type: integer
          description: Error code (0 indicates success)
        errorMessage:
          type: string
          description: Human-readable error or success message
  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