Changes to ONTAP REST API calls
Suggest changes
PDFs
NetApp continues to enhance and update the ONTAP REST API with each major product release. These updates can occasionally include changes to existing API calls that disrupt access to ONTAP functionality. There are also additional considerations when using the API as well as some documentation errors.
Changes to existing ONTAP REST API calls
Changes to the existing ONTAP REST API calls, such as endpoints and parameters, can affect software that uses the API. In most situations, depending on your environment, these are considered breaking changes. You should review the list in the table below to determine if there is an impact to your automation environment. Each entry includes the applicable API endpoint or area, a description of the change, and the ONTAP release it was introduced.
| API endpoint or area | Description of behavior | ONTAP release |
|---|---|---|
Azure Key Vault |
The REST API endpoint used to enable and disable Azure Key Vault (AKV) now executes asynchronously instead of synchronously. This affects the POST operation for enabling AKV and the DELETE operation for disabling it. Clients using these API calls should update their code to handle the asynchronous responses, which involves checking the job status instead of just the HTTP status code. This change primarily impacts Azure NetApp Files (ANF) environments that manage Azure Key Vault configurations through the ONTAP REST API. |
9.19.1 |
|
The field _links in the response was removed from the duogroup for these endpoints. There is no recommended customer action or workaround. The field is expected to be added back in a future ONTAP release. |
9.15.1 |
Additional REST API usage considerations
In addition to disruptive or breaking changes, there are several additional considerations when using the ONTAP REST API. There are different types of issues, including the introduction of new or alternative API calls as well as changes to ONTAP's internal processing. Each entry includes the applicable API endpoint or area, a description of the behavior, and the ONTAP release it was introduced.
| API endpoint or area | Description of behavior | ONTAP release |
|---|---|---|
|
The endpoint used to create containers has been enhanced to support several volume configuration parameters that were previously only available through |
9.19.1 |
|
When retrieving license information through the REST API for very large ONTAP clusters (32 nodes or greater), you may experience slow response times. This issue affects System Manager licensing tabs and automated workflows that query all licenses simultaneously. To reduce the impact, you can fetch licenses for specific features one at a time using query parameters or use the CLI with command |
9.19.1 |
ONTAP REST API reference documentation errors
As NetApp enhances and updates the ONTAP REST API, sometimes errors can be introduced in the online reference documentation. These errors can create confusion when using the API but generally don't impact or disrupt your ONTAP automation software or environment. You should review the list of errors in the table below. This will help you better understand and navigate the ONTAP REST API reference documentation. Each entry includes the applicable API endpoint or area, a description of the error, and the ONTAP release it was introduced.
| API endpoint or area | Description of change | ONTAP release |
|---|---|---|
|
The REST API documentation for the endpoint indicates that specifier is a valid field. However, the quota specifier is not supported with this endpoint. There is no recommended customer action or workaround. |
9.6 |