REST API - Overview

SnapProtect REST (Representational State Transfer) APIs represent operations that are performed in the CommCell Console. You can use the REST APIs to create custom interfaces that focus on the operations your users need. The REST APIs are implemented on the HTTP protocol, so you can use them with your preferred programming language and tools.

Required Capabilities

A REST API client should support the following:

  • HTTPS and basic authentication
  • HTTP GET, POST, and DELETE requests
  • Ability to set and read request and response headers
  • XML or JSON responses

Supported HTTP Methods

GET: Lists objects and includes the information needed to perform additional operations on the object. Sample use: list all of the users in the CommCell.

POST: Creates or updates objects. Most requests using the POST method require XML in the request body. XML template files are provided. Sample use: create a client group.

DELETE: Removes objects. Sample use: delete a storage policy.

Responses

Responses to these API requests are served either in XML or JSON formats. To request a format, use the Accept request header, for example:

Accept: application/xml

Accept: application/json