A newer release of this product is available.
- ONTAP 9.6 REST API docs
-
REST API reference
- Getting started with the ONTAP REST API
-
Application
- Application overview
- Retrieve applications
- Create an application
- Retrieve application components
- Retrieve application component Snapshot copies
- Create an application component Snapshot copy
- Delete an application component Snapshot copy
- Retrieve a Snapshot copy for a specific application component
- Restore an application component Snapshot copy
- Retrieve an application component
- Manage application Snapshot copies
- Delete an application and all associated data
- Retrieve an application
- Update application properties
- Retrieve application templates
- Retrieve an application template
- Cloud
-
Cluster
- Cluster overview
- Manage clusters
- Retrieve cluster chassis
- View and manage cluster jobs
- Manage cluster licensing
- Manage a cluster license package
- Retrieve historical performance metrics for the cluster
- Manage cluster nodes
- Manage cluster peers
- Manage cluster schedules
-
Manage cluster software
- Cluster software endpoint overview
- Retrieve the cluster software profile
- Update the cluster software version
- Download a software or firmware package
- Retrieve the software installation request history details
- Retrieve cluster software packages
- Delete a software package from the cluster
- Retrieve the software package information
-
NAS
- NAS overview
- Manage NAS audit configurations
- Manage home directory search paths
- Manage CIFS services
- Manage CIFS shares
- Manage share-level ACL
-
Manage CIFS UNIX symlink mapping
- Protocols CIFS unix-symlink-mapping endpoint overview
- Retrieve UNIX symbolic link mappings for CIFS clients
- Create a UNIX symbolic link mapping for a CIFS client
- Delete a UNIX symbolic link mapping for CIFS clients
- Retrieve a UNIX symbolic link mapping for CIFS clients
- Update a UNIX symbolic link mapping for CIFS clients
- Manage FPolicy configuration
-
Manage FPolicy engine configuration
- Protocols fpolicy svm.uuid engines endpoint overview
- Retrieve the FPolicy engine configuration for all engines of an SVM
- Create the FPolicy engine configuration for an SVM
- Delete an FPolicy external engine configuration
- Retrieve a particular FPolicy engine configuration for an SVM
- Update a specific FPolicy engine configuration for an SVM
-
Manage FPolicy event configuration
- Protocols fpolicy svm.uuid events endpoint overview
- Retrieve an FPolicy event configuration for all events for an SVM
- Create the FPolicy event configuration for an SVM
- Delete a specific FPolicy event configuration for an SVM
- Retrieve a specific FPolicy event configuration for an SVM
- Update a specific FPolicy event configuration for an SVM
- Manage SVM FPolicy configuration
-
Manage NFS export policies
- Protocols NFS export-policies endpoint overview
- Retrieve export policies
- Create an export policy
- Delete an export policy
- Retrieve an export policy
- Update export policy properties
- Retrieve export policy rules
- Create an export policy rule
- Delete an export policy rule
- Retrieve an export policy rule
- Update the properties of an export policy rule
- Retrieve export policy rule clients
- Create an export policy rule client
- Delete an export policy client
- View and update Kerberos interfaces
- Manage Kerberos realms
- Manage NFS services
- View and create Vscan configuration
- Manage Vscan configuration
- Manage Vscan On-Access policies
- Manage Vscan On-Demand policies
-
Manage Vscan scanner-pool configuration
- Protocols Vscan svm.uuid scanner-pools endpoint overview
- Retrieve the Vscan scanner-pool configuration for an SVM
- Create the Vscan scanner-pool configuration for an SVM
- Delete a Vscan scanner-pool configuration
- Retrieve the Vscan scanner-pool configuration for an SVM
- Update the Vscan scanner-pool configuration for an SVM
- NVMe
-
Name-services
- Name-services overview
- Manage DNS configurations
- Manage LDAP server configurations
- Manage name mappings for SVMs
-
Manage NIS server configurations
- Name-services NIS endpoint overview
- Retrieve NIS domain configurations of all SVMs
- Create the NIS domain and server configuration for a data SVM
- Delete the NIS domain configuration for an SVM
- Retrieve the NIS domain and server configurations for an SVM
- Update the NIS domain and server configuration for an SVM
- Networking
-
SAN
- SAN overview
- Retrieve FC port information
- Manage FC WWPN aliases
- Manage FC services for SVMs
-
Manage SAN igroups
- Protocols SAN igroups endpoint overview
- Retrieve initiator groups
- Create an initiator group
- Retrieve initiators of an initiator group
- Add initiators to an initiator group
- Delete an initiator from an initiator group
- Retrieve an initiator
- Delete an initiator group
- Retrieve an initiator group
- Update an initiator group
- Manage iSCSI credentials
- Manage iSCSI services
- View iSCSI sessions
- Manage SAN LUN maps
- Manage LUNs
- SVM
-
Security
- Security overview
- Manage security-related accounts
- Manage scoped user accounts
- View and update audit settings
-
Forward audit logs to syslog/splunk servers
- Security audit destinations endpoint overview
- Define a remote syslog or splunk server to receive audit information
- Define the remote syslog or splunk server information
- Delete the remote syslog or splunk server information
- Retrieve the remote syslog or splunk server information
- Update the remote syslog or splunk server information
- View administrative audit logs
- Manage LDAP server configuration
- Manage NIS configuration
- Manage SAML service
- Update the user account password
- Manage security certificates
- Manage key managers
- List key servers configured in an external key manager
- Add primary key servers to an external key manager
- Delete a primary key server
- Retrieve key servers configured in an external key manager
- Update a primary key server
- View and update login message configuration
- Manage security roles
- View or delete a role
- Manage role privilege details
- Manage role privilege path
- SnapMirror
-
Storage
- Storage overview
- Retrieve or create a collection of storage aggregates
- Retrieve a collection of cloud stores used by an aggregate
- Attach an object store to an aggregate or add a second object store as a mirror
- Remove a cloud target from an aggregate
- Retrieve the cloud store for an aggregate
- Update a cloud store
- Manage storage aggregate plexes
- Delete an aggregate specified by the UUID
- Retrieve an aggregate specified by the UUID
- Update an aggregate specified by the UUID
- Report cluster-wide storage details across different tiers
- Manage disks
- Create a clone of the file
- Manage FlexCache volumes
- Manage storage FlexCache origin volumes
- Manage storage ports
- Manage QoS policies
- Manage storage qtrees
- Storage quota
- Manage storage quota reports
- Manage storage quota policy rules
- Manage shelves
- Manage Snapshot copy policies
- Create a Snapshot copy policy
- Manage storage volumes
- Retrieve historical performance metrics for a volume
- Manage volume Snapshot copies
-
Support
- Support overview
- Manage AutoSupport configuration
- Manage AutoSupport messages
- Manage cluster configuration backup information
- Manage EMS configuration
- Manage event destinations
- Manage an event destination instance
- Retrieve events
- Create or retrieve event filters
- Manage event filters
- Create or retrieve filter rules
- Manage event filter rules
- Manage the EMS event catalog
- Legal notices