{ "info": { "_postman_id": "cdfb8a3c-4538-4c17-ba25-e6b434c2f352", "name": "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.\n\nContact Support:\n Name: Commvault Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:25:10.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "lastUpdatedBy": "35240", "uid": "35240-cdfb8a3c-4538-4c17-ba25-e6b434c2f352" }, "item": [ { "name": "Client", "item": [ { "name": "{clientId}", "item": [ { "name": "Commvault Get client details", "id": "faeabe27-9f05-411e-b858-e43e85d29b5c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/Client/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "Client", ":clientId" ], "variable": [ { "id": "b02f9155-21a9-4e3e-af9f-a1d19d55b761", "key": "clientId", "value": "", "description": "(Required) Unique identifier for the client" } ] }, "description": "Retrieves detailed properties of a specific client including installed agents, network configuration, and activity control settings." }, "response": [ { "id": "3c6f2896-52d7-4e4e-b4e1-0dbb406ecbb3", "name": "Client details", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authtoken", "value": "" } ], "url": { "raw": "{{baseUrl}}/Client/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "Client", ":clientId" ], "variable": [ { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"clientProperties\": [\n {\n \"client\": {\n \"clientId\": \"\",\n \"clientName\": \"\",\n \"hostName\": \"\",\n \"displayName\": \"\"\n },\n \"clientProps\": {\n \"activityControl\": {\n \"enableBackup\": \"\",\n \"enableRestore\": \"\"\n },\n \"contentIndexingProps\": {}\n }\n },\n {\n \"client\": {\n \"clientId\": \"\",\n \"clientName\": \"\",\n \"hostName\": \"\",\n \"displayName\": \"\"\n },\n \"clientProps\": {\n \"activityControl\": {\n \"enableBackup\": \"\",\n \"enableRestore\": \"\"\n },\n \"contentIndexingProps\": {}\n }\n }\n ]\n}", "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-3c6f2896-52d7-4e4e-b4e1-0dbb406ecbb3" }, { "id": "666e04a0-a90e-4c09-b9b7-66b5a7de59ae", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authtoken", "value": "" } ], "url": { "raw": "{{baseUrl}}/Client/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "Client", ":clientId" ], "variable": [ { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-666e04a0-a90e-4c09-b9b7-66b5a7de59ae" }, { "id": "4bd9b08a-281e-4999-8594-9b1a4f4e41a9", "name": "Client not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authtoken", "value": "" } ], "url": { "raw": "{{baseUrl}}/Client/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "Client", ":clientId" ], "variable": [ { "key": "clientId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-4bd9b08a-281e-4999-8594-9b1a4f4e41a9" } ], "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-faeabe27-9f05-411e-b858-e43e85d29b5c" }, { "name": "Commvault Update client properties", "id": "f4e51a68-edfd-43cf-9dd4-9ab7e29351ac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"clientProperties\": {\n \"client\": {\n \"clientName\": \"\"\n },\n \"clientProps\": {\n \"activityControl\": {\n \"enableBackup\": \"\",\n \"enableRestore\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/Client/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "Client", ":clientId" ], "variable": [ { "id": "99e96868-b7df-4558-9002-0cadfdf63066", "key": "clientId", "value": "", "description": "(Required) Unique identifier for the client" } ] }, "description": "Updates properties of a specific client such as display name, activity control, or network settings." }, "response": [ { "id": "496ec846-535f-44c4-9cd9-19113186267c", "name": "Client updated successfully", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authtoken", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"clientProperties\": {\n \"client\": {\n \"clientName\": \"\"\n },\n \"clientProps\": {\n \"activityControl\": {\n \"enableBackup\": \"\",\n \"enableRestore\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/Client/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "Client", ":clientId" ], "variable": [ { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}", "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-496ec846-535f-44c4-9cd9-19113186267c" }, { "id": "9571b224-7a14-4b58-8fd0-606c564816f9", "name": "Invalid request", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authtoken", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"clientProperties\": {\n \"client\": {\n \"clientName\": \"\"\n },\n \"clientProps\": {\n \"activityControl\": {\n \"enableBackup\": \"\",\n \"enableRestore\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/Client/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "Client", ":clientId" ], "variable": [ { "key": "clientId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-9571b224-7a14-4b58-8fd0-606c564816f9" }, { "id": "2bc60986-4e34-4f3e-b83e-2489d2f06265", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authtoken", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"clientProperties\": {\n \"client\": {\n \"clientName\": \"\"\n },\n \"clientProps\": {\n \"activityControl\": {\n \"enableBackup\": \"\",\n \"enableRestore\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/Client/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "Client", ":clientId" ], "variable": [ { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-2bc60986-4e34-4f3e-b83e-2489d2f06265" }, { "id": "254be953-05e1-42fe-823e-466b0be23d87", "name": "Client not found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authtoken", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"clientProperties\": {\n \"client\": {\n \"clientName\": \"\"\n },\n \"clientProps\": {\n \"activityControl\": {\n \"enableBackup\": \"\",\n \"enableRestore\": \"\"\n }\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/Client/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "Client", ":clientId" ], "variable": [ { "key": "clientId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-254be953-05e1-42fe-823e-466b0be23d87" } ], "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-f4e51a68-edfd-43cf-9dd4-9ab7e29351ac" }, { "name": "Commvault Retire or delete a client", "id": "41706f4a-b242-4980-bab5-be68540fe40b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/Client/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "Client", ":clientId" ], "variable": [ { "id": "a48e4dc5-c81b-4b7e-b30b-3b489c074c54", "key": "clientId", "value": "", "description": "(Required) Unique identifier for the client" } ] }, "description": "Retires or deletes a client from the CommServe. This removes the client configuration but may preserve backup data based on retention policies." }, "response": [ { "id": "1521be6b-425a-4a75-83a3-2c479a5672a1", "name": "Client deleted successfully", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authtoken", "value": "" } ], "url": { "raw": "{{baseUrl}}/Client/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "Client", ":clientId" ], "variable": [ { "key": "clientId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"errorMessage\": \"\"\n}", "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-1521be6b-425a-4a75-83a3-2c479a5672a1" }, { "id": "b0ee6ac5-1b4c-4ac9-89ed-2990a3c71bc1", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authtoken", "value": "" } ], "url": { "raw": "{{baseUrl}}/Client/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "Client", ":clientId" ], "variable": [ { "key": "clientId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-b0ee6ac5-1b4c-4ac9-89ed-2990a3c71bc1" }, { "id": "4e2b57b3-951d-4ecb-a04a-ffd22d50bf45", "name": "Client not found", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authtoken", "value": "" } ], "url": { "raw": "{{baseUrl}}/Client/:clientId", "host": [ "{{baseUrl}}" ], "path": [ "Client", ":clientId" ], "variable": [ { "key": "clientId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-4e2b57b3-951d-4ecb-a04a-ffd22d50bf45" } ], "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-41706f4a-b242-4980-bab5-be68540fe40b" } ], "id": "438568b2-526a-41ba-b243-5714aeb2a884", "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-438568b2-526a-41ba-b243-5714aeb2a884" }, { "name": "Commvault List all clients", "id": "375566a2-5f09-4086-b946-362fd61ce55d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/Client", "host": [ "{{baseUrl}}" ], "path": [ "Client" ] }, "description": "Retrieves a list of all clients registered in the CommServe, including servers, workstations, laptop clients, and virtual machine proxies." }, "response": [ { "id": "c1be45bb-f4f4-4791-890c-f4bb6e4e5cb4", "name": "List of clients", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "Authtoken", "value": "" } ], "url": { "raw": "{{baseUrl}}/Client", "host": [ "{{baseUrl}}" ], "path": [ "Client" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"clientProperties\": [\n {\n \"client\": {\n \"clientId\": \"\",\n \"clientName\": \"\",\n \"hostName\": \"\",\n \"displayName\": \"\"\n },\n \"clientProps\": {\n \"activityControl\": {\n \"enableBackup\": \"\",\n \"enableRestore\": \"\"\n },\n \"contentIndexingProps\": {}\n }\n },\n {\n \"client\": {\n \"clientId\": \"\",\n \"clientName\": \"\",\n \"hostName\": \"\",\n \"displayName\": \"\"\n },\n \"clientProps\": {\n \"activityControl\": {\n \"enableBackup\": \"\",\n \"enableRestore\": \"\"\n },\n \"contentIndexingProps\": {}\n }\n }\n ]\n}", "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-c1be45bb-f4f4-4791-890c-f4bb6e4e5cb4" }, { "id": "1f81093a-83fc-4eec-92ae-b02ec6631927", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "Authtoken", "value": "" } ], "url": { "raw": "{{baseUrl}}/Client", "host": [ "{{baseUrl}}" ], "path": [ "Client" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-1f81093a-83fc-4eec-92ae-b02ec6631927" } ], "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-375566a2-5f09-4086-b946-362fd61ce55d" } ], "id": "51627abe-7b30-4f1e-aa38-faff84b78a84", "createdAt": "2026-07-28T01:25:11.000Z", "updatedAt": "2026-07-28T01:25:11.000Z", "uid": "35240-51627abe-7b30-4f1e-aa38-faff84b78a84" } ], "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" } ] }