{
  "opencollection": "1.0.0",
  "info": {
    "name": "Commvault Automation API",
    "version": "v2"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authtoken",
      "value": "{{Authtoken}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Workflows",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Commvault List all workflows",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{webserver}/webconsole/api/Workflow"
          },
          "docs": "Retrieves a list of all workflows defined in the CommServe, including built-in and custom workflows. Workflows automate multi-step processes such as provisioning, disaster recovery drills, and data migration."
        },
        {
          "info": {
            "name": "Commvault Get workflow details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{webserver}/webconsole/api/Workflow/:workflowId",
            "params": [
              {
                "name": "workflowId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for the workflow"
              }
            ]
          },
          "docs": "Retrieves the detailed definition of a specific workflow, including its activities, inputs, conditions, and execution history."
        },
        {
          "info": {
            "name": "Commvault Delete a workflow",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{webserver}/webconsole/api/Workflow/:workflowId",
            "params": [
              {
                "name": "workflowId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for the workflow"
              }
            ]
          },
          "docs": "Deletes a custom workflow from the CommServe. Built-in workflows cannot be deleted."
        },
        {
          "info": {
            "name": "Commvault Execute a workflow",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{webserver}/webconsole/api/Workflow/:workflowName/Action/Execute",
            "params": [
              {
                "name": "workflowName",
                "value": "",
                "type": "path",
                "description": "Name of the workflow to execute"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Triggers the execution of a workflow by name. Input parameters can be provided in the request body to customize the workflow execution. Returns a job ID for tracking the execution."
        },
        {
          "info": {
            "name": "Commvault Deploy a workflow definition",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{webserver}/webconsole/api/Workflow/Deploy"
          },
          "docs": "Deploys a new workflow or updates an existing workflow definition in the CommServe. The workflow XML definition is provided in the request body."
        }
      ]
    },
    {
      "info": {
        "name": "Schedules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Commvault List all schedules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{webserver}/webconsole/api/Task",
            "params": [
              {
                "name": "taskType",
                "value": "",
                "type": "query",
                "description": "Filter by task type"
              }
            ]
          },
          "docs": "Retrieves a list of all scheduled tasks configured in the CommServe, including backup schedules, auxiliary copy schedules, and administrative operation schedules."
        },
        {
          "info": {
            "name": "Commvault Get schedule details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{webserver}/webconsole/api/Task/:taskId",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for the scheduled task"
              }
            ]
          },
          "docs": "Retrieves detailed configuration of a specific scheduled task, including its schedule pattern, associated entities, and execution options."
        },
        {
          "info": {
            "name": "Commvault Update a schedule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{webserver}/webconsole/api/Task/:taskId",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for the scheduled task"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the configuration of an existing scheduled task, including its schedule pattern, enabled state, and execution options."
        },
        {
          "info": {
            "name": "Commvault Delete a schedule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{webserver}/webconsole/api/Task/:taskId",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for the scheduled task"
              }
            ]
          },
          "docs": "Deletes a scheduled task from the CommServe."
        },
        {
          "info": {
            "name": "Commvault Enable a schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{webserver}/webconsole/api/Task/:taskId/Action/Enable",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for the scheduled task"
              }
            ]
          },
          "docs": "Enables a previously disabled scheduled task."
        },
        {
          "info": {
            "name": "Commvault Disable a schedule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{webserver}/webconsole/api/Task/:taskId/Action/Disable",
            "params": [
              {
                "name": "taskId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for the scheduled task"
              }
            ]
          },
          "docs": "Disables a scheduled task, preventing it from executing until re-enabled."
        }
      ]
    },
    {
      "info": {
        "name": "Policies",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Commvault Get global data protection filters",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{webserver}/webconsole/api/V4/CommcellGlobalFilter"
          },
          "docs": "Retrieves the global exclusion filters applied to all backup operations, such as temporary file patterns, operating system cache directories, and other commonly excluded content."
        },
        {
          "info": {
            "name": "Commvault Update global data protection filters",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{webserver}/webconsole/api/V4/CommcellGlobalFilter",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the global exclusion filters for backup operations."
        }
      ]
    },
    {
      "info": {
        "name": "Operations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Commvault Execute a qcommand operation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{webserver}/webconsole/api/QCommand/qoperation"
          },
          "docs": "Executes an arbitrary Commvault command-line (qcommand) operation through the REST API. This provides programmatic access to operations that may not have dedicated REST endpoints."
        }
      ]
    },
    {
      "info": {
        "name": "Scripts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Commvault List automation scripts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{webserver}/webconsole/api/Script"
          },
          "docs": "Retrieves a list of all automation scripts registered in the CommServe, including pre/post backup scripts and custom automation scripts."
        },
        {
          "info": {
            "name": "Commvault Get script details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{webserver}/webconsole/api/Script/:scriptId",
            "params": [
              {
                "name": "scriptId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for the automation script"
              }
            ]
          },
          "docs": "Retrieves the details of a specific automation script, including its content, associated triggers, and execution history."
        },
        {
          "info": {
            "name": "Commvault Execute an automation script",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{webserver}/webconsole/api/Script/:scriptId/Action/Execute",
            "params": [
              {
                "name": "scriptId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for the automation script"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Triggers the execution of an automation script with optional input parameters."
        }
      ]
    }
  ],
  "bundled": true
}