Skip to main content

REST services offered in Unified Manager for DM Series

You should be aware of the REST services and operations offered, before you start using the Unified Manager for DM Series APIs.

The provisioning and administrative APIs that are used for configuring the API server support the read (GET) or write (POST, PATCH, DELETE) operations. The following are some examples of the GET, PATCH, POST, and DELETE operations that are supported by the APIs:

  • Example for GET: GET /management-server/admin/backup-file-info retrieves backup file details. The maximum number of records that is returned by the GET operation is 1000.
    Note
    The APIs enable you to filter, sort, and order the records by specific supported attributes.
  • Example for PATCH: PATCH /storage-provider/svms/{key} modifies the properties of an SVM, using its unique key.
  • Example for POST: POST /storage-provider/svms creates a custom Storage Virtual Machine (SVM).
  • Example for DELETE: DELETE /storage-provider/access-endpoints/{key} deletes an access endpoint from a LUN, SVM, or file share by using its unique key.
The REST operations that can be performed by using the APIs depend on the role of the Operator, Storage Administrator, or Application Administrator user.
Table 1.
User roleSupported REST method
OperatorRead-only access to data. Users with this role can run all GET requests.
Storage Administrator

Read access to all data. Users with this role can run all GET requests.

Additionally, they have write access (to run PATCH, POST, and DELETE requests) to perform specific activities, such as managing, storage service objects, and storage management options.

Application AdministratorRead and write access to all data. Users with this role can run GET, PATCH, POST, and DELETE requests for all functions.