REST API

Commvault REST (Representational State Transfer) APIs represent operations that are performed via the Commvault API Gateway. 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. The REST APIs are implemented on the HTTP protocol, so you can use them with your preferred programming language and tools.

Getting Started with API

Any tenant user can access Commvault APIs using username and password authentication. To create a new user, see Creating a User.

Service Accounts

MSP administrators can use access tokens for accessing Core and partner APIs. If you are using an existing service account, it will continue to work.

REST API

Partner video: REST API for MSP

API Endpoint URL

To perform operations using API, ensure all API call are made with the URL https://api.metallic.io/

Commvault Cloud REST API Reference

For REST API reference information, see Commvault REST API Reference.

Rate-Limits

API requests are rate limited in Commvault on a per tenant basis. This is to ensure consistent performance of the service and fair usage for all Commvault customers.

Once you exceed a certain number of requests in a specific period, Commvault will return an error.

If you are rate limited, Commvault API endpoint will return a 429 in the response code. You can either wait the designated time by the X-RateLimit-Period before making calls again, or switch to making calls at a frequency slightly longer than the X-RateLimit-Limit or X-RateLimit-Period

The following are the default limits for read and write operations on a per tenant basis:

  • The rate limit for write operations is 100 API per hour per Commvault tenant

  • The rate limit for read operations is 1000 per hour per Commvault tenant

To increase rate limits, contact the Commvault Support Team.

×

Loading...