Sign in to my dashboard Create an account

Transform your Automation to ONTAP REST API from ONTAPI

People crossing the street

Share this page

Mahalakshmi G
Mahalakshmi G

Automation is a strategic imperative for most organizations. NetApp was one of the first companies to come up with its own proprietary APIs, then called ZAPI, today known as NetApp® ONTAPIs.

As Enterprises are looking to modernize, simplify, and standardize their automation approach with industry-standard APIs, NetApp has decided to shift from traditional proprietary APIs to Industry-Standard REST API, adding support for an expansive REST API starting ONTAP® 9.6 software release.

Starting with ONTAP 9.7, new features and enhancements are available only through the ONTAP REST API for automation. With the current ONTAP 9.10.1 release, ONTAP REST covers almost 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.

This blog describes the most important things that you need to be aware of while transform ing to ONTAP REST APIs - the timeline for ONTAPI end of availability, transition of existing products, and resources available to transform existing ONTAPI based automation to industry-standard ONTAP REST APIs.

Figure 1) ONTAP REST API categories.

Figure 1 Image

ONTAPI EOA: Timeline

NetApp ONTAPI (ZAPI) will reach end of availability (EOA) in January 2023. (CPC-00410: EOA- ONTAPI)

For customers who are using ONTAPI to automate their data management, ONTAP release in FY22-Q4, will be the final ONTAP version to include ONTAPI.

The subsequent ONTAP release, targeted for Q2 of calendar year 2023 will not support ONTAPI calls indicating that they are no longer available. For full information about ONTAP version support plans, refer to the Version Support page.

Following figure shows the significant milestones that are associated with ONTAP releases starting with ONTAP 9.8.

Figure 2 Image

PowerShell Toolkit

For existing ONTAP PowerShell Toolkit customers, the transition from ONTAPI to the ONTAP REST API will be managed internally by the tool itself.

By FY22 Q4 timeframe , the ONTAP PowerShell Toolkit will prompt users for ONTAPI or ONTAP REST API usage, according to the underlying ONTAP version.

Existing Ansible users

For customers who use Ansible-certified NetApp modules, the transition from ONTAPI to the ONTAP REST API will be seamless, meaning the modules provides flexibility to choose between existing ONTAPI call until end of support and ONTAP REST for new features and attributes, reducing the effort and time for reinvestment.

By FY22 Q4 timeframe is released, Ansible modules will use ONTAPI or the ONTAP REST API, according to the underlying ONTAP version.

Transforming to ONTAP REST APIs

Step 1

In the journey of transforming from ONTAPI to ONTAP REST APIs, the first step is to identify the REST API endpoint to use in place of an existing ONTAPI call, refer to ONTAPI to REST API mapping information. This document maps ONTAPI to its equivalent REST API, including parameters. The mapping document is available for ONTAP 9.8, 9.9.1 and 9.10.1 software versions. For additional information, read the FAQ ONTAPI (ZAPI) to ONTAP REST API transformation.


Step 2

The NetApp ONTAP REST API enables you to modernize your automated processes as you transform from ONTAPI to REST. If you identify ONTAPI calls, or parameters required by your automation processes that are not supported by the ONTAP REST APIs, there are two methods for reporting requirements:

  1. If you are working with a NetApp account team directly, a request can be made to submit requests or gaps via ONTAPI to ONTAP REST API gaps form. This form should be submitted along with the use case or use cases the requirement is related to.

  2. Contact NetApp Technical Support. NetApp support can file a requirement on your behalf. Refer the KB article How to request a feature for ONTAP REST API.

Step 3

In order to help the completion of automation story meanwhile, customers and partners can use the private CLI passthrough option until the direct API endpoint is available. This ONTAP REST option enables user to execute the CLI commands. To learn more about private CLI passthrough, read the blog Using the private CLI passthrough with the ONTAP REST API and the sample scripts.

Step 4

Plenty of resources are available on the NetApp DevNet ONTAP Resources page to help you transform to industry standard ONTAP REST. NetApp eases your automation transition journey through enablers such as Python Client Library, Ansible information, and planning to support REST in the PowerShell Toolkit.

Hands-on ONTAP REST resources include hands-on lab, Python sample scripts, and Ansible modules to get you started on your ONTAP REST automation journey.

Step 5

ONTAP REST API is included with NetApp ONTAP software and fully supported by NetApp. If ONTAP REST API endpoints report an error or don’t provide the expected response, contact NetApp Technical Support.

  • An #api Slack channel is available for ONTAP REST API users to interact, learn, ask questions, and contribute to the community.

    • To join the NetApp #Slack community (thePub), go to Select Slack from the upper menu bar to join the community. Many other channels are also available, including Containers, Configuration Management (configurationmgmt), and Harvest.

    • Customers can also reach out through their account team to file gap request.


Mahalakshmi G

Mahalakshmi works as Technical Marketing Engineer for OnCommand System Manager. As she is part of Product Management, she loves solving real-world customer issues. She also has a deep passion for automation coding. Apart from work, Mahalakshmi is keen on music and enjoys traveling to new places.

View all Posts by Mahalakshmi G

Next Steps

Drift chat loading