Unified Manager for DM Series API access and categories
The Unified Manager for DM Series APIs enable you to manage and provision storage objects in your environment. You can also access the Unified Manager web UI to perform some of these functions.
Constructing a URL to directly access REST APIs
You can access the REST APIs directly through a programming language, such as Python, C#, C++, JavaScript, and so forth. Enter the host name or IP address and the URL to access the REST APIs in the format
https://<hostname>/api
Accessing the online API documentation page
You can access the API Documentation reference content page that is packaged along with the product to display the API documentation, as well as to manually issue an API call (on the interface, for example, Swagger). You can access this documentation on clicking the
Alternatively, enter the host name or IP address and the URL to access the REST API page in the format
https://<hostname>/docs/api/
The online API reference will be made available again in version 9.9.
Categories
The API calls are organized into functionally based on the areas or categories. To locate a specific API, click the applicable API category.
- data center
- This category contains the APIs that help you to view and manage your data center storage objects. The REST APIs under this category provide information about the clusters, nodes, aggregates, volumes, LUNs, file shares, namespaces, and other elements in your data center.
- management-server
- The APIs under the management-server category contain the jobs API. Jobs are operations that are scheduled for asynchronous execution related to managing of storage objects or workloads on Unified Manager.
- storage-provider
- This category contains all of the provisioning APIs required for managing and provisioning file shares, LUNs, Performance Service Levels, and Storage Efficiency Policies. The APIs also enable you to configure access endpoints, Active Directories, as well as assign Performance Service Levels and Storage Efficiency Policies on storage workloads.
- administration
- This category contains the APIs used for running administrative tasks, such as maintaining backup settings, viewing trust store certificates for the Unified Manager datasources, and managing ONTAP clusters as datasources for Unified Manager.
- gateway
- Unified Manager enables you to invoke ONTAP REST APIs through the APIs under the gateway category and manage the storage objects in your data center.
- security
- This category contains APIs for managing Unified Manager users.