SnapCenter Software 5 Manuals ( CA08871-403 )

Every REST API call is performed as an HTTP request to the SnapCenter Server system which generates an associated response to the client. This request and response pair is considered an API transaction.

Before using the API, you should be familiar with the input variables available to control a request and the contents of the response output.

Each of the resources available through the SnapCenter REST API is accessed based on the CRUD model:

For some of the resources, only a subset of the operations is supported.

Each resource instance or object is assigned a unique identifier when it is created. In most cases, the identifier is a 128-bit UUID. These identifiers are globally unique within a specific SnapCenter Server.

After issuing an API call that creates a new object instance, a URL with the associated ID is returned to the caller in the location header of the HTTP response. You can extract the identifier and use it on subsequent calls when referring to the resource instance.

Depending on the resource path and HTTP method, an API call can apply to a specific object instance or a collection of objects.

SnapCenter performs an HTTP request received from a client either synchronously or asynchronously.

The security provided with the REST API is based primarily on the existing security features available with SnapCenter. The following security is used by the API: