API reference

Contributors dmp-netapp Download PDF of this page

You can access the details of all the ONTAP REST API calls, including the HTTP methods, input parameters, and responses. This complete reference is helpful when developing automation applications using the REST API.

Note You can access the API reference content at your local ONTAP system or at the NetApp Developer Network web site.

Accessing the ONTAP API documentation page

You can access the ONTAP API online documentation page at your local ONTAP system.

Before you begin

You must have the following:

  • IP address or host name of the ONTAP cluster management LIF

  • User name and password for an account with authority to access the ONTAP REST API

Steps
  1. Type the URL in your browser and press Enter:

  2. Sign in using the ONTAP account.

    The ONTAP API documentation page is displayed with the API calls organized in major resource categories at the bottom.

  3. As an example of an individual API call, scroll down to the cluster category and click GET /cluster.

Accessing the reference content at NetApp DevNet

You can access the ONTAP REST API reference documentation at the NetApp Developer Network web site.

Steps
  1. Navigate to the ONTAP REST API page at the NetApp Developer Network web site:

  2. Scroll down and under Online REST APIs Reference click the link for the appropriate ONTAP version.

    The ONTAP API documentation page is displayed with the API calls organized in major resource categories at the bottom.

  3. As an example of an individual API call, scroll down to the cluster category and click GET /cluster.