Commvault Clients API

openapi: 3.1.0
info:
  title: Commvault Automation Agents Clients 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: Clients
  description: Manage clients (servers, workstations, virtual machines)
paths:
  /Client:
    get:
      operationId: listClients
      summary: Commvault List all clients
      description: Retrieves a list of all clients registered in the CommServe, including servers, workstations, laptop clients, and virtual machine proxies.
      tags:
      - Clients
      responses:
        '200':
          description: List of clients
          content:
            application/json:
              schema:
                type: object
                properties:
                  clientProperties:
                    type: array
                    items:
                      $ref: '#/components/schemas/Client'
        '401':
          description: Unauthorized
  /Client/{clientId}:
    get:
      operationId: getClient
      summary: Commvault Get client details
      description: Retrieves detailed properties of a specific client including installed agents, network configuration, and activity control settings.
      tags:
      - Clients
      parameters:
      - $ref: '#/components/parameters/clientId'
      responses:
        '200':
          description: Client details
          content:
            application/json:
              schema:
                type: object
                properties:
                  clientProperties:
                    type: array
                    items:
                      $ref: '#/components/schemas/Client'
        '401':
          description: Unauthorized
        '404':
          description: Client not found
    put:
      operationId: updateClient
      summary: Commvault Update client properties
      description: Updates properties of a specific client such as display name, activity control, or network settings.
      tags:
      - Clients
      parameters:
      - $ref: '#/components/parameters/clientId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateClientRequest'
      responses:
        '200':
          description: Client updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
        '404':
          description: Client not found
    delete:
      operationId: deleteClient
      summary: Commvault Retire or delete a client
      description: Retires or deletes a client from the CommServe. This removes the client configuration but may preserve backup data based on retention policies.
      tags:
      - Clients
      parameters:
      - $ref: '#/components/parameters/clientId'
      responses:
        '200':
          description: Client deleted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
        '401':
          description: Unauthorized
        '404':
          description: Client not found
components:
  schemas:
    Client:
      type: object
      properties:
        client:
          type: object
          properties:
            clientId:
              type: integer
              description: Unique client identifier
            clientName:
              type: string
              description: Display name of the client
            hostName:
              type: string
              description: Network hostname of the client
            displayName:
              type: string
              description: User-friendly display name
        clientProps:
          type: object
          properties:
            activityControl:
              type: object
              properties:
                enableBackup:
                  type: boolean
                  description: Whether backup is enabled
                enableRestore:
                  type: boolean
                  description: Whether restore is enabled
            contentIndexingProps:
              type: object
              description: Content indexing configuration
    GenericResponse:
      type: object
      properties:
        errorCode:
          type: integer
          description: Error code (0 indicates success)
        errorMessage:
          type: string
          description: Human-readable error or success message
    UpdateClientRequest:
      type: object
      properties:
        clientProperties:
          type: object
          properties:
            client:
              type: object
              properties:
                clientName:
                  type: string
                  description: New display name for the client
            clientProps:
              type: object
              properties:
                activityControl:
                  type: object
                  properties:
                    enableBackup:
                      type: boolean
                    enableRestore:
                      type: boolean
  parameters:
    clientId:
      name: clientId
      in: path
      required: true
      description: Unique identifier for the client
      schema:
        type: integer
  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