ONTAP Rest API Discussions

Coffee breaks with REST - Episode #4: ONTAPI (ZAPI) Reporting tool


In the previous Episode#3 of blog series, you would have experienced hands-on with ONTAP REST using Postman.

In this fourth episode of blog series, we will look at the resources available for ONTAPI (ZAPI) users to take the transition path to ONTAP REST APIs, which would be the primary external facing API for long term. 

Starting with the ONTAP 9.7 (released at the end of 2019), new features and enhancements from ONTAP are available only through the ONTAP REST API for automation. With the current ONTAP 9.10.1 release (January 2022), ONTAP REST covers most of the use cases in the spectrum of ONTAP management, such as NAS and SAN provisioning, data protection, security, and automatic ONTAP software and firmware upgrades.

We have developed a tool to help our customers and partners to transition from ONTAPI (ZAPI) to ONTAP REST API. This tool consists of three python scripts, covering three different use cases.

The following table describes the scripts.


Note: Python 3.7 or higher is required to run the scripts.




Apache log scraper to find ONTAPIs (ZAPIs) called against ONTAP nodes


Command line script to pull session statistics data from ONTAP


Script to find equivalent REST details of ZAPI and attributes passed

You can download the ONTAPI Usage Reporting Tool(wheel file) from GitHub link: GitHub: ONTAPI Usage Reporting Tool 

To install the scripts

  1. Make sure that Python 3.7 or later is installed.
  2. Download the wheel file from GitHub.
  3. From the command prompt, pip install netapp_ztools-1.0.0-py3-none-any

         This command installs all the required dependencies.

  1. Open the command prompt and navigate to python_folder python38\Lib\site-packages\netapp_ztools\ to see the installed scripts.



To learn more about the usage of each script in ONTAPI Usage Reporting tool, read the blog -  Blog: ONTAPI Usage reporting tool .