Skip to main content

Considerations when using the ONTAP REST API

There are several characteristics of the ONTAP REST API affecting its operation and use. You should be aware of these considerations before issuing an API call.

You should review the resources exposed through the API.

  • Object references and access
    The resource instances or objects exposed through the ONTAP REST API can be referenced and accessed in several different ways.
  • Users of the ONTAPI API and ONTAP CLI
    ONTAPI is a set of API calls provided through the Network Manageability SDK that can be used to administer ONTAP storage systems. There are differences between the REST API and the ONTAPI API calls, as well as between the REST API and ONTAP CLI. You should understand these differences before using the REST API in a production environment.
  • Security using RBAC
    The REST API expands the role-based access control (RBAC) capabilities when using ONTAP. You can create user accounts with custom roles to restrict access to the REST endpoints.
  • Performance metrics for storage resources
    ONTAP collects performance metrics about selected SVM storage objects and protocols, and reports this information through the REST API. You can use this data to monitor the performance of an ONTAP system.
Related reference