Commvault Databases API

openapi: 3.1.0
info:
  title: Commvault Automation Agents Databases 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: Databases
  description: Manage database protection
paths:
  /V4/DatabaseServers:
    get:
      operationId: listDatabaseServers
      summary: Commvault List database servers
      description: Retrieves a list of all database servers configured for backup, including SQL Server, Oracle, SAP HANA, and other database platforms.
      tags:
      - Databases
      responses:
        '200':
          description: List of database servers
          content:
            application/json:
              schema:
                type: object
                properties:
                  databaseServers:
                    type: array
                    items:
                      $ref: '#/components/schemas/DatabaseServer'
        '401':
          description: Unauthorized
components:
  schemas:
    DatabaseServer:
      type: object
      properties:
        clientId:
          type: integer
          description: Unique client identifier
        clientName:
          type: string
          description: Database server name
        databaseType:
          type: string
          description: Database platform type
          enum:
          - SQLServer
          - Oracle
          - SAP_HANA
          - MySQL
          - PostgreSQL
          - DB2
          - Informix
        instanceName:
          type: string
          description: Database instance name
        protectionStatus:
          type: string
          description: Protection status
        lastBackupTime:
          type: integer
          description: Unix timestamp of last successful backup
  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