Commvault api Jul 11, 2022 · Hello Team, Is there a way to get the DDB Engine dependent copy information through REST API? I am specifically looking for information that is available in Java console:Storage Resources > Deduplication Engines > DDB_ENGINE_NAME > Dependent Copy Information. job Main file for performing operations on a job. Is there a wa We would like to show you a description here but the site won’t allow us. But let’s get one step back to the Swagger UI. Commvault helps transform your business and unlocks possibilities with its extensive and open API-first integrations. Partner API: Use these APIs to configure and manage your MSP tenant. Nov 17, 2025 · Commvault REST (Representational State Transfer) APIs represent operations that are performed via the Commvault API Gateway. Oct 17, 2022 · Community Commvault Cloud Topics Virtualization and Containers Rest API - GET VM (lists info of all VMs) - how to get complete record info for a particular VM? Nov 10, 2025 · REST API OverviewREST API Overview Updated Mon, Nov 10, 2025 Commvault REST (Representational State Transfer) APIs represent operations that are performed in the CommCell Console. Is it possible to run this API call as part of the script from Linux shell (as a curl command) or from Powershell? Or are API calls executable only as p Jul 6, 2022 · Hello Community ,I need to Pull out VMs( VSA snapshot backup) backup history ( all available backup details like start time , end time , status) through an API . Apr 1, 2024 · Hello,We are running small env using Metallic SaaS,I’ve went through the API options ( api. At first I’m creating an authorization token using the Sandbox:Then I switch to the API Explorer and open the login (using the lock on the right hand side) and paste the token I got before:I try to get a list of plans using t The Clumio REpresentational State Transfer (REST) Application Programming Interface (API) provides a simple interface for the Clumio operations you need to perform to fully protect your data. org/) which generates the correct one, but the command line at centOS does not. After the authentication token is obtained, it must be inserted into the Authtoken header for all requests. But still, Commvault uses energy on trying, our firewall uses energy on stopping Commvault from trying, our customers asks why our backup solution try’s to contact some Sep 26, 2025 · The <API_Explorer> is an application in Web Console for visualizing and interacting with the latest Commvault RESTful APIs. am I missing something?I am trying to use powershell to make some changes outside of Commvault but the credential manager api doesn’t Feb 1, 2024 · Hi Bezzar, It may be easiest to start with the Backup Job Summary Report. The REST APIs are implemented on the HTTP protocol, so you can use them with your preferred programming language and We would like to show you a description here but the site won’t allow us. You can use the REST APIs to create custom interfaces that focus on the operations your users need, such as authentication, creating resellers, submitting fulfillment requests, and getting account and usage information. I can run the following which gets me the active backup jobs, but does not show anything else:curl -ks --location --request GET "https Dec 28, 2022 · Is there any way we access Rest API without token ? because we just run the script on the local commvault computer and we don't want user + password in the plaintext ?Thank you Hi, maybe someone from the community also needed to automatically restart “Completed with errors” VM job only for failed vm’s? There is an option from GUI, but it would be much easier to restart it using api or wokflow. Python SDK Cvpysdk is a Python library available on GitHub that allows developers to interact with Commvault software products. I just downloaded the Postman CommVault Rest API Workspace and now I’m trying to start with the basic: authentication. Tutorials and How-To Guides: Step-by-step instructions for common development tasks and use cases. The REST APIs are implemented on the HTTP protocol, so you can use them with your preferred programming language and Apr 17, 2024 · For API documentation I would use api. Nov 10, 2025 · Commvault Software Documentation Procedures to be completed in the Command Center The most important topics for our most-used features A simplified navigation HyperScale Appliance The most frequently used developer tools such as REST API Configuration options for multi-tenant CommCell environments Nov 10, 2025 · Getting Started with the Commvault REST APIGetting Started with the Commvault REST API Updated Mon, Nov 10, 2025 Commvault Developer Rest API Documentation Welcome Explore our predefined API requests using Postman. I’m ultimately try to get to the same state that the Command Center shows for it’s active jobs. So I build a Powershell script to collect data, do different checks and fire Rest calls to Commvault. Module cvpysdk. May 30, 2025 · REST API OverviewREST API Overview Updated Fri, May 30, 2025 Commvault REST (Representational State Transfer) APIs represent operations that are performed in the CommCell Console. And the return brings all the historical events, an immense list. Hi guys,I have been using the CVPowerShellSDK_v1 and was able to create tools and scripts for our team. Hello everyone, Is it possible to get Full Schedules via API call? i am able to get the schedules and sub tasks inside the schedule but i could not find a way to differentiate schedules from Full, vs Incremental vs Full Synthetic? Granted Full Synthetic has a display name so it lets you differentia Developer SDK - Python. When you enter credentials in the sandbox environment, you should see the headers populate to check if these values are getting properly encrypted as you would expect. Jul 2, 2024 · Commvault API Collection for Postman This guide outlines how to set up and use the Commvault Postman collection for API interactions. i don’t found a lot of documentation for the specific use of REST API in powersh Mar 21, 2025 · Has anyone used apis to login to the command center? I think my code below works for login, but doesn’t work for logout. In REST Webservice API Sandbox I am able to create API call - see below. i want to connect to commserver from PowerShell with token or something ? We would like to show you a description here but the site won’t allow us. May 30, 2022 · Hi, Update for anyone that was interested, or for myself in the future: For agent based simple api for subclient id works as in the initial 1st message of this post. Feb 15, 2024 · For those that don’t want to spend a lot of time trying to figure it out, I just figured I would post the basics and then you can have fun exploring for yourself. Which API can be used to get information about all available backu Jul 9, 2024 · Friends,I want to use a script to retire/delete VMs from Commvault when the last backup is at a certain age. You’ll want to secure t We are creating an integration between our monitoring tool (Zabbix) and the Commvault API, to have backup alerts centralized in a single location (Zabbix). com. ThanksAbdul Mar 10, 2023 · Hi,An external application wants to use the Commvault API. Commvault® Core APIs Partner APIs CloudRewind APIs Clumio APIs FAQs Change Log Latest (SP42) Search K Nov 10, 2025 · Was this page helpful? Nov 17, 2025 · REST API - Authentication: POST Login Updated Mon, Nov 17, 2025 Commvault REST APIs support token-based authentication via the Authtoken request header. The new Commvault APIs are organized by workload and operations for intuitive navigation and search for both Software and SaaS deployment types. Commvault Developer Portal Code. Now, I would like to move a step further and make my own API Calls with the Invoke-RestMethod in PowerShell but I am having a hard time to get started (disclaimer: I have a backgrouind as a sysadm We would like to show you a description here but the site won’t allow us. This simplifies automation and scripting tasks for administrators working with Commvault backup and data management solutions. I cannot f Commvault can help simplify approval processes and streamline operations with our Cloud integration within your ServiceNow interface. Just wondering if it’s possible to disable Commvaults try to contact api. Oct 17, 2022 · So I’m trying to run a REST api call to get all current running jobs. Learn how to use Commvault REST APIs to perform operations in the CommandCenter. Problem I had was with a backup launch for VM which is backed up in the subclient of vcenter’s connector in CV. com), looking for a way to get the ‘Activity Control’ status of an Azure Oject storage instance ( Blob / Azure file). To ensure data is transmitted between parties securely, each Clumio user must authenticate into the REST Jul 2, 2024 · Commvault API Collection for Postman This guide outlines how to set up and use the Commvault Postman collection for API interactions. I created a new test user inside the C The <API_Explorer> enables users to visualize and interact with the latest Commvault RESTful APIs through resources and models. Feb 20, 2025 · I have some requirements from SOC : the API endpoint must be protected by API Managet like TYK the API calls must be secured by MFA Does Commvault support the use of an API Gateway like TYK ? Does anyone now if we can implement MFA over API ? Thanks ! Best answer by Jacek Piechucki “ Does anyone now if we can implement MFA over API ?” Yes We would like to show you a description here but the site won’t allow us. Jul 2, 2024 · Onboard HyperV and Backup using APIsHere is a step-by-step guide to onboard a particular hypervisor and perform backup using Commvault REST APIs. To start working with Commvault REST APIs, import the collection into Postman and complete a simple setup procedure. Feb 17, 2025 · I want to use Delinea secret server to manage password rotation for the local admin account. I would like to understand why Teams backup requires a Microsoft API Delegated Permissions and why can’t Microsoft API Application Permissions instead. Only applicable for SharePoint Online We would like to show you a description here but the site won’t allow us. We need the REST API - PostmanCommvault REST APIs are available as a Postman collection. So for virtual if you want to launch backup - you have to use GUID. is there a another way where we can connect commvault using PowerShell without providing credentials. The POST Login API is used to retrieve the authentication token. It provides a way to manage CommCell operations using Python code by utilizing the software's REST APIs. We would like to show you a description here but the site won’t allow us. With the API Code Assist feature, you can automate and customize Commvault APIs with ease. The Commvault GetVM API is only giving the status about recent backup . Using the documentation, they are doing a GET to the Commvault API. For example: I add a dataset > HTTP > Rest API: /JobThe above returns me all the jobs, how do I filter job Sep 13, 2023 · Hello, I’m a DE integrating Commvault API to be ingested in our DWH for a customer. I used the equivalent API functionality in the Command Center to get the JSON. The example below is for creating a Storage Pool. As I did not find a plug-in like CyberArk, I want use API c We would like to show you a description here but the site won’t allow us. Nov 10, 2025 · REST API ReferenceREST API Reference Updated Mon, Nov 10, 2025 Commvault software supports REST APIs that you can use to perform operations, such as suspending or resuming a job, and to manage entities, such as updating subclient properties. We have upgraded Metallic APIs with new and enhanced Commvault Cloud unified APIs. Dec 23, 2023 · I’m new to REST API and the Commvault API Explorer and my first tests fail. If this doesn't meet your needs, please elaborate on what you’re ultimately trying to accomplish and I Commvault partnered with Dell Technologies® to maximize your PowerProtect DD®'s with a data protection platform. JobController __init__(commcell_object) -- initializes the instance of JobController class associated with the specified commcell __str__ Apr 13, 2021 · You can check REST API process and view the post requests before sending in the sandbox environment - REST API - Test Environment. We are looking to automate Commvault IDA agents Installation and client settings configuration such as encryption, dedupe , storage policy , filters , schedules , database subclient settings such as oracle home, path etc. Nov 10, 2025 · Commvault software supports REST APIs that you can use to perform operations, such as suspending or resuming a job, and to manage entities, such as updating subclient properties. Metallic APIs on this site will be deprecated on Dec 31, 2024. commvault. Find documentation, authentication, and examples of APIs for data protection, data management, and data insights. Commvault API requires base64 encoded password hash. Learn how to use Commvault REST APIs to manage and protect your data. I’ve redacted specific details. Please update your automation and integration using the new Commvault Cloud APIs here Note - Individual API doc links in the current site have been updated with the new links. In testing the REST APIs, I've found that the GET VM API only returns Hi Team,Greetings! instead of Connect-CVServer command from PowerShell to connect commserve. Once you have an authcode, you can then submit whatever api request you want. CVPySDK (Developer SDK - Python) is a Python Package for Commvault Software … REST API Documentation Get Started Commvault REST API Documentation Commvault REST (Representational State Transfer) APIs represent operations that are performed in the CommandCenter. 26 days ago Community Commvault Cloud Topics Developer Tools, Integration and Automation Problems with API We would like to show you a description here but the site won’t allow us. Amount of details in the API response PseudoClientType string Possible values: [VSPseudo, CloudApps] Specify the type of pseudoclient to filter the API response. Pre requisites Get the credential that can be used from Credential API Get the accessNodes that can be used from AccessNodes API Get the plans that can be used from Plans Step 1: Install the hypervisor client To create a hypervisor, we first need Dec 17, 2022 · So the first step in any api request is that you first authenticate/login to get an authcode. You can use the REST APIs to create custom interfaces that focus on the operations your users need. This guide details how to communicate with the Clumio REST API to manage Clumio's resources and perform operations including data protection and on-demand restore. . Nov 28, 2024 · Hi all, I’m looking for a little bit of assistance. For Postman beginners, refer to the Getting Started guide. Learn more now. I’ve Found almost all the instance properties beside the one I need. Jul 2, 2024 · The Commvault REST API provides powerful tools to integrate and automate your data management operations. com:443 is being used by the CVD service to verify a servers location, which we do not need. The REST APIs are implemented on the HTTP protocol, so you can use them with your preferred programming language and Nov 10, 2025 · REST API OverviewREST API Overview Updated Mon, Nov 10, 2025 Commvault REST (Representational State Transfer) APIs represent operations that are performed in the CommCell Console. Nov 10, 2025 · The <API_Explorer> enables users to visualize and interact with the latest Commvault RESTful APIs through resources and models. Commvault API specs, API docs, OpenAPI support, SDKs, GraphQL, developer docs, CLI, IDE plugins, API pricing, developer experience, authentication, and API styles. Contribute to Commvault/cvpysdk development by creating an account on GitHub. com And in regards of which API to use, all endpoints should provide the same functionality, it should only depend on which ones are available to you Hi All,i need help to create a powershell script using REST API command. By leveraging these APIs, you can build robust and efficient interfaces that cater to the unique needs of your users. Does anyone has custom workflows deployed for agent installation and client c namestring required Unique Teams app name serverPlan object required idint32 namestring azureApp object applicationIdstring required Azure Application ID applicationSecretstring required Azure app secret key, needs to be base64 encoded certificatePasswordstring Password of the azure application certificate and must be in base64 encoded format. 36) Commvault Platform Release 2023E (11. I am attempting to use commvault report data to import to powerbi and the question I have is what Key should I use? Is there a way to generate a semi-permanent api key so I can do refreshes against the report dataset? We would like to show you a description here but the site won’t allow us. If you're new to Postman, no worries! Check out their Getting Started guide to get up to speed. Jan 30, 2024 · The Commvault Rest API - Getting Started 6 minute read In the previous post I briefly discussed using the Commvault Rest API with PowerShell but I didn’t really expand upon one of the key points to understand when automatinng with the Rest API. The resources are the CommCell entities (such as agents) and functions (such as logging in and out of the CommCell environment) that users can interact with using REST API endpoints and methods (POST, GET, DELETE). Just to exclude any wrong configuration inside Postman. VSPseudo to return a list of virtualization clients. Nov 10, 2025 · From <API_Explorer>, users can execute REST API requests and view responses from the CommCell environment directly from the Web Console. Accessing the Clumio REST API gateway requires authentication. Jun 11, 2024 · I’ve recently deployed an M365 backup from Commvault Cloud. If someone found an option to do that it would be great if yu could share it! Th Aug 26, 2021 · API References: Detailed documentation of our REST APIs, enabling you to interact with Commvault systems programmatically. com:443? The api. As we are a tenant customer, we don’t have options like Workflows. May 16, 2025 · Application Permissions for the Azure App for Teams Updated Fri, May 16, 2025 Commvault requires certain Azure API permissions for Teams. You can use access tokens as an alternative to token-based authentication via the Authtoken request header. Postman Collection Commvault REST APIs are available as a Postman collection. skyhookwireless. I would like to know which ports, protocol, direction to open between the Commserve & VM containing the external applications. Nov 10, 2025 · REST API OverviewREST API Overview Updated Mon, Nov 10, 2025 Commvault REST (Representational State Transfer) APIs represent operations that are performed in the CommCell Console. 42 Commvault Long-Term Support Release 11. curl -k -L Hi all, I need to display failed backup jobs from yesterday using a script. . Login to the commcell using this request and save the token before calling any other API We would like to show you a description here but the site won’t allow us. Commvault APIsAuthentication Token Security Scheme Type: apiKey Header parameter name: Authtoken The rest api has the ability to list credentials, and to get details for the credentials but cannot retrieve the actual credentials?This seems incomplete / pointless. Postman Postman Commvault REST APIs provide a comprehensive way to manage and protect data, supporting token-based authentication and integration with various tools and applications. I can delete via the fol Nov 10, 2025 · Use the Arlie API Code Assist feature to generate step-by-step code for operations on Commvault entities, such as servers and laptops. Nov 10, 2025 · API tokens Updated Mon, Nov 10, 2025 The Clumio Representational State Transfer (REST) Application Programming Interface (API) provides a simple interface for the Clumio operations you need to perform to fully protect your data. The API Code Assist feature generates code using the information in api. CloudApps to return a list of all cloud apps pseudo client We would like to show you a description here but the site won’t allow us. Aug 5, 2022 · I’m going to resurrect this for selfish purposes. Oct 2, 2023 · Hi All. Recommended customer use online tool (https://www. Customize the criteria as needed, and then scroll down to the Job Details table, click the gear, and choose REST API: It should be relatively easy to customize the URI provided to pick dates and times dynamically. Commvault Innovation Release 11. Commvault APIs are grouped into Four categories: Core API: Use these APIs to configure and manage the backup of your workloads. 40 Commvault Platform Release 2024E (11. Create Explore APIs Unlock the power of our APIs We would like to show you a description here but the site won’t allow us. The REST APIs are implemented on the HTTP protocol and support GET, POST, PUT and DELETE methods. Collaborate. The token must be extracted from the login process to utilize for future authorization of Rest calls. Community Commvault Cloud Topics Developer Tools, Integration and Automation Has anyone used the "REST API - Filters for Search or List APIs" successfully? Dec 26, 2022 · Commvault REST API and PowerShell 2 minute read You can use the Commvault Rest API with PowerShell! Navigate to the public API for Commvault and change the language to PowerShell to get started. Eventually I want it to login, create a credential in the vault and logout but I’m also having issues removing httponly from the session. You can execute Commvault REST API requests by inserting an access token in a Bearer Token header. JobController: Class for managing jobs on this commcell JobManagement: Class for performing Job Management operations Job: Class for keeping track of a job and perform various operations on it. So basically 3 API calls to run a backup The <API_Explorer> enables users to visualize and interact with the latest Commvault RESTful APIs through resources and models. base64encode. Nov 10, 2025 · Commvault REST (Representational State Transfer) APIs represent operations that are performed via the Commvault API Gateway. The REST APIs are implemented on the HTTP protocol, so you can use them with your preferred programming language and Commvault® Core APIs Partner APIs CloudRewind APIs Clumio APIs FAQs Hi guys! I’m completely new to REST API. There is a firewall between the machine where the external application resides and the Commserve host. The syntax, a sample request, and a sample response are provided for each API. Microsoft Graph API Commvault requires the following Microsoft API permissions for Teams. It’s not pretty, but should get those not familiar with using the REST API with PowerShell a good base to start. This API documentation covers all the APIs exposed by metallic for all the We would like to show you a description here but the site won’t allow us. I’m trying to build a custom report for our monitoring needs, the issue is I’m not sure how to filter out data received by an API Call. The <API_Explorer> enables users to visualize and interact with the latest Commvault RESTful APIs through resources and models. 32) Hi all,We have 2 environments using Commvault (Dev - 195 VMs and Prod - 2175 VMs). kqbv tueyo rjolr aoiaqbob cwnhwmqf ewalico dajiuw nslupoi nidjb lbvjfpa ykhih meiyhr trmy xhd hmhi