{
  "info": {
    "_postman_id": "0d4b8ac3-cfed-4d8e-a667-2584ef2e90e8",
    "name": "Commvault Automation Agents 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.\n\nContact Support:\n Name: Commvault Support",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "createdAt": "2026-07-28T01:25:08.000Z",
    "updatedAt": "2026-07-28T01:25:08.000Z",
    "lastUpdatedBy": "35240",
    "uid": "35240-0d4b8ac3-cfed-4d8e-a667-2584ef2e90e8"
  },
  "item": [
    {
      "name": "Agent",
      "item": [
        {
          "name": "Commvault List agents for a client",
          "id": "2cf76898-15b5-46e0-9953-9b92dece08ad",
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          },
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/Agent?clientId=<integer>",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "Agent"
              ],
              "query": [
                {
                  "description": "(Required) Client ID to list agents for",
                  "key": "clientId",
                  "value": "<integer>"
                }
              ]
            },
            "description": "Retrieves a list of all agents (iDataAgents) installed on a specific client. Agents represent the backup module for a particular application type (File System, SQL, Exchange, etc.)."
          },
          "response": [
            {
              "id": "ca569604-5aba-4a1f-b9f1-87262a6c508c",
              "name": "List of agents",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  },
                  {
                    "description": "Added as a part of security scheme: apikey",
                    "key": "Authtoken",
                    "value": "<API Key>"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/Agent?clientId=<integer>",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "Agent"
                  ],
                  "query": [
                    {
                      "description": "(Required) Client ID to list agents for",
                      "key": "clientId",
                      "value": "<integer>"
                    }
                  ]
                }
              },
              "status": "OK",
              "code": 200,
              "_postman_previewlanguage": "json",
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "cookie": [],
              "responseTime": null,
              "body": "{\n  \"agentProperties\": [\n    {\n      \"idaEntity\": {\n        \"applicationId\": \"<integer>\",\n        \"applicationName\": \"<string>\",\n        \"clientId\": \"<integer>\",\n        \"clientName\": \"<string>\"\n      }\n    },\n    {\n      \"idaEntity\": {\n        \"applicationId\": \"<integer>\",\n        \"applicationName\": \"<string>\",\n        \"clientId\": \"<integer>\",\n        \"clientName\": \"<string>\"\n      }\n    }\n  ]\n}",
              "createdAt": "2026-07-28T01:25:09.000Z",
              "updatedAt": "2026-07-28T01:25:09.000Z",
              "uid": "35240-ca569604-5aba-4a1f-b9f1-87262a6c508c"
            },
            {
              "id": "54a6bc16-6c16-4b45-a627-cf3c31c05fdb",
              "name": "Unauthorized",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "description": "Added as a part of security scheme: apikey",
                    "key": "Authtoken",
                    "value": "<API Key>"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/Agent?clientId=<integer>",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "Agent"
                  ],
                  "query": [
                    {
                      "description": "(Required) Client ID to list agents for",
                      "key": "clientId",
                      "value": "<integer>"
                    }
                  ]
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "_postman_previewlanguage": "text",
              "header": [],
              "cookie": [],
              "responseTime": null,
              "body": null,
              "createdAt": "2026-07-28T01:25:09.000Z",
              "updatedAt": "2026-07-28T01:25:09.000Z",
              "uid": "35240-54a6bc16-6c16-4b45-a627-cf3c31c05fdb"
            }
          ],
          "createdAt": "2026-07-28T01:25:09.000Z",
          "updatedAt": "2026-07-28T01:25:09.000Z",
          "uid": "35240-2cf76898-15b5-46e0-9953-9b92dece08ad"
        }
      ],
      "id": "c76a7bbf-f028-4c9d-9eb3-5985c507ab45",
      "createdAt": "2026-07-28T01:25:09.000Z",
      "updatedAt": "2026-07-28T01:25:09.000Z",
      "uid": "35240-c76a7bbf-f028-4c9d-9eb3-5985c507ab45"
    }
  ],
  "auth": {
    "type": "apikey",
    "apikey": [
      {
        "key": "key",
        "value": "Authtoken",
        "type": "string"
      },
      {
        "key": "value",
        "value": "{{apiKey}}",
        "type": "string"
      },
      {
        "key": "in",
        "value": "header",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "webserver",
      "value": "webconsole.example.com"
    },
    {
      "key": "baseUrl",
      "value": "https://{{webserver}}/webconsole/api"
    }
  ]
}