Skip to main content

ONTAP REST API resource categories

The resources available through the ONTAP REST API are organized in categories, as displayed on the ONTAP API documentation page. A brief description of each of the resources with the base resource paths is presented below, along with additional usage considerations where appropriate.

This section describes the REST resources for the latest version of the product. If you need to understand the changes that were made from the previous version, see the ONTAP change list.

Attention
For many of the REST endpoints, you can include a UUID key as part of the path string to access a specific object instance. However, you can also access objects using a property value on a query parameter.
  • Application
    You can use these API calls to manage the ONTAP application resources.
  • Cloud
    You can use these API calls to manage connections to object storage resources in the cloud.
  • Cluster
    You can use these API calls to manage ONTAP clusters and the related resources.
  • Manage
    This resource supports the initial implementation of the ONTAP self-healing feature.
  • Name services
    You can use these API calls to manage the name services supported by ONTAP.
  • NAS
    You can use these API calls to manage the CIFS and NFS settings for the cluster and SVMs.
  • NDMP
    The Network Data Management Protocol provides a standard for backing up NAS devices. You can use these API calls to manage the NDMP services.
  • Networking
    You can use these API calls to manage the physical and logical networking resources used with the cluster.
  • NVMe
    You can use these API calls to manage resources supporting non-volatile memory express (NVMe).
  • Object store
    You can use these API calls to access S3-based object storage.
  • SAN
    You can use these API calls to manage storage area networking (SAN) resources.
  • Security
    These API calls can be used to manage the cluster and SVM security settings.
  • SnapLock
    SnapLock is a storage-based implementation of the traditional WORM (write once, read many) optical solution and provides for the long-term retention of data. You can use these API calls to administer the SnapLock feature.
  • SnapMirror
    You can use these API calls to manage the SnapMirror data protection technology.
  • Storage
    You can use these API calls to manage the physical and logical storage.
  • Support
    You can use these API calls to manage the ONTAP features used to support a cluster.
  • SVM
    You can use these API calls to manage storage virtual machines (SVMs).
Related concepts
Related tasks