Skip to main content

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.

Objectives of this guide​

This guide provides a detailed description of the ONTAP REST API. It includes the conceptual information needed to understand and access the API as well as workflow examples to complete selected administrative tasks.

Audience assumptions​

This guide is suitable for a diverse audience, including software developers automating ONTAP administration tasks and decision makers who only need a high-level understanding of the API.

Note
If you plan to use the API to perform ONTAP administration tasks, you must already have experience administering ONTAP storage systems. This guide does not provide information related to ONTAP administration. You should refer to the ONTAP 9 documentation as needed.

API Compatibility​

An effort is made to keep the ONTAP REST API backwards compatible from release to release. However, there may be instances where it is necessary to make a breaking change to accommodate new product functionality. Refer to the API online documentation (https://<cluster_management_ip_address>/docs/api) or the ONTAP change list for changes to the API.

Related concepts
Related reference
Related information