Using API Code Assist

The Arlie API Code Assist feature is a code generation tool for creating integrations and automation using Commvault APIs. You can interact with the Arlie API Code Assist feature using natural human language, which means you can input your commands intuitively, similar to how you would communicate with another person.

Use the Arlie API Code Assist feature to generate step-by-step code for operations on Commvault entities, such as servers and laptops. The API Code Assist feature generates code using the information in api.commvault.com.

With the API Code Assist feature, you can automate and customize Commvault APIs with ease. It identifies the proper API, arranges the inputs correctly, and executes them in the correct order based on your input. This feature simplifies the Commvault APIs, empowering you to automate processes and customize Commvault to your specific needs. Additionally, you can replace parameters in the API request payload to customize the API for your needs.

Procedure

1. From the navigation pane, go to Developer Tools > API Code Assist.

   The API Code Assist page appears.

2. At the bottom of the page, in the How can I help? box, enter the operation to perform. For example, enter "How to update a plan?"

   The appropriate API request and response appear.

3. To customize the API request, you can replace parameters in the API request payload by clicking on the Edit button at the top-right of the Request tab.

   For example, to use the APIs to log on to the Command Center, you can replace the password field with your password.

4. Save the changes and click Copy .

   You can use the modified and copied API request in your script.