REST API Developer’s Guide
This document is available in PDF format:
- Deciding whether to use the ONTAP REST API Developers Guide
The ONTAP 9 REST API Developers Guide describes the REST application programming interface provided with ONTAP 9. You can use the API to administer ONTAP systems and the related storage resources. - Understanding the ONTAP REST API
Beginning with version 9.6, ONTAP includes a REST web services API. You can use the REST API to deploy and administer ONTAP storage resources. Before using the API, you should understand its design, architectural components, and limitations. - Getting started with the ONTAP REST API
You can quickly get started using the ONTAP REST API. Accessing the API provides some perspective before you begin using it with the more complex workflow processes on a live system. - 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. - ONTAP REST API resource categories
The resources available through the ONTAP REST API are organized in categories, as displayed on the ONTAP API documentation page. A brief description of each of the resources with the base resource paths is presented below, along with additional usage considerations where appropriate. - Workflow processes using the ONTAP REST API
You can use the ONTAP REST API to administer ONTAP systems and perform other storage administrative tasks. Each of the tasks is described using a workflow process consisting of one or more API calls. - ONTAP REST API transactions illustrated
Each API transaction consists of an HTTP request and the associated response. You can review the following transaction examples to improve your understanding of how the ONTAP REST API works. - Where to find additional information
You should review the following additional resources as part of using the ONTAP REST API to administer ONTAP clusters and the related storage resources. - Contacting Support
You can contact Support to obtain help for your issue. - Notices
Lenovo may not offer the products, services, or features discussed in this document in all countries. Consult your local Lenovo representative for information on the products and services currently available in your area.
Give documentation feedback