Commvault Schedule Policies API

openapi: 3.1.0
info:
  title: Commvault Automation Agents Schedule 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: Schedule Policies
  description: Manage schedule policies for automated operations
paths:
  /SchedulePolicy:
    get:
      operationId: listSchedulePolicies
      summary: Commvault List schedule policies
      description: Retrieves a list of all schedule policies defined in the CommServe. Schedule policies automate backup, auxiliary copy, and other operations on a recurring basis.
      tags:
      - Schedule Policies
      responses:
        '200':
          description: List of schedule policies
          content:
            application/json:
              schema:
                type: object
                properties:
                  taskDetail:
                    type: array
                    items:
                      $ref: '#/components/schemas/SchedulePolicy'
        '401':
          description: Unauthorized
components:
  schemas:
    SchedulePolicy:
      type: object
      properties:
        taskId:
          type: integer
          description: Unique schedule policy identifier
        taskName:
          type: string
          description: Name of the schedule policy
        taskType:
          type: string
          description: Type of task
        subTasks:
          type: array
          items:
            type: object
            properties:
              subTaskName:
                type: string
                description: Name of the sub-task
              operationType:
                type: string
                description: Operation type (Backup, Restore, etc.)
              pattern:
                type: object
                properties:
                  freq_type:
                    type: string
                    description: Frequency type (Daily, Weekly, Monthly)
                  active_start_time:
                    type: integer
                    description: Schedule start time
  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