ONTAP 9.6 REST API reference
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
Application applications application.uuid snapshots endpoint overview
Retrieve an application Snapshot copy
Create an application Snapshot copy
Delete an application Snapshot copy
Retrieve an application Snapshot copy
Restore an application Snapshot copy
Delete an application and all associated data
Retrieve an application
Update application properties
Retrieve application templates
Retrieve an application template
Cloud
Cloud overview
Manage cloud targets
Cloud targets endpoint overview
Retrieve cloud targets in the cluster
Create a cloud target
Delete a cloud target
Retrieve a cloud target
Update a cloud target
Cluster
Cluster overview
Manage clusters
Cluster endpoint overview
Retrieve the cluster configuration
Update the cluster configuration
Create a cluster
Retrieve cluster chassis
Cluster chassis endpoint overview
Retrieve a collection of chassis
Retrieve a chassis
View and manage cluster jobs
Cluster jobs endpoint overview
Retrieve recent asynchronous jobs
Retrieve details of an asynchronous job
Update the state of an asynchronous job
Manage cluster licensing
Cluster licensing licenses endpoint overview
Retrieve license packages
Install one or more feature licenses
Manage a cluster license package
Cluster licensing licenses name endpoint overview
Delete a license
Retrieve a license package
Retrieve historical performance metrics for the cluster
Manage cluster nodes
Cluster nodes endpoint overview
Retrieve nodes in a cluster
Add a node or nodes to a cluster
Retrieve node information
Update node information
Manage cluster peers
Cluster peers endpoint overview
Retrieve cluster peers
Create a peering relationship
Delete a cluster peer
Retrieve a cluster peer instance
Update a cluster peer instance
Manage cluster schedules
Cluster schedules endpoint overview
Retrieve schedules
Create a schedule
Delete a schedule
Retrieve a schedule
Update a schedule
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
Protocols audit endpoint overview
Retrieve audit configurations
Create an audit configuration
Delete an audit configuration
Retrieve the audit configuration for an SVM
Update the audit configuration for an SVM
Manage home directory search paths
Protocols CIFS home-directory search-paths endpoint overview
Retrieve CIFS home directory search paths
Create a home directory search path
Delete a CIFS home directory search path
Retrieve a CIFS home directory search path for an SVM
Re-order a CIFS home directory search path
Manage CIFS services
Protocols CIFS services endpoint overview
Retrieve CIFS servers
Create a CIFS server
Delete a CIFS server and related configurations
Retrieve a CIFS server
Update CIFS mandatory and optional parameters
Manage CIFS shares
Protocols CIFS shares endpoint overview
Retrieve CIFS shares
Create a CIFS share
Delete a CIFS share
Retrieve a CIFS share
Update a CIFS share
Manage share-level ACL
Protocols CIFS shares svm.uuid share acls endpoint overview
Retrieve a share-level ACL on a CIFS share
Create a share-level ACL on a CIFS share
Delete a share-level ACL on a CIFS share
Retrieve a share-level ACL on a CIFS share for a user or group
Update a share-level ACL on a CIFS share
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
Protocols fpolicy endpoint overview
Retrieve an FPolicy configuration
Create an FPolicy configuration
Delete the FPolicy configuration for an SVM
Retrieve the FPolicy configuration for an SVM
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
Protocols fpolicy svm.uuid policies endpoint overview
Retrieve the FPolicy configuration for an SVM
Create the FPolicy configuration for an SVM
Delete the FPolicy configuration for an SVM
Retrieve the FPolicy configuration for an SVM
Update the FPolicy configuration for an SVM
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
Protocols NFS Kerberos interfaces endpoint overview
Retrieve Kerberos interfaces
Retrieve a Kerberos interface
Update Kerberos interface properties
Manage Kerberos realms
Protocols NFS Kerberos realms endpoint overview
Retrieve Kerberos realms
Create a Kerberos realm
Delete a Kerberos realm
Retrieve a Kerberos realm
Update Kerberos realm properties
Manage NFS services
Protocols NFS services endpoint overview
Retrieve NFS configuration for SVMs
Create the NFS configuration for an SVM
Delete the NFS configuration for an SVM
Retrieve the NFS configuration for an SVM
Update the NFS configuration for an SVM
View and create Vscan configuration
Protocols Vscan endpoint overview
Retrieve the Vscan configuration
Create a Vscan configuration
Manage Vscan configuration
Protocols Vscan server-status endpoint overview
Retrieve the Vscan server status
Delete a Vscan configuration
Retrieve the Vscan configuration for an SVM
Update the Vscan configuration for an SVM
Manage Vscan On-Access policies
Protocols Vscan svm.uuid on-access-policies endpoint overview
Retrieve a Vscan On-Access policy
Create a Vscan On-Access policy
Delete an antivirus On-Access policy configuration
Retrieve the Vscan On-Access policy configuration for an SVM
Update the Vscan On-Access policy configuration for an SVM
Manage Vscan On-Demand policies
Protocols Vscan svm.uuid on-demand-policies endpoint overview
Retrieve a Vscan On-Demand policy
Create a Vscan On-Demand policy
Delete a Vscan On-Demand configuration
Retrieve the Vscan On-Demand configuration for an SVM
Update the Vscan On-Demand policy configuration for an SVM
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
NVMe overview
View NVMe interfaces
Protocols NVMe interfaces endpoint overview
Retrieve NVMe interfaces
Retrieve an NVMe interface
Manage NVMe services
Protocols NVMe services endpoint overview
Retrieve NVMe services
Create an NVMe service
Delete an NVMe service
Retrieve an NVMe service
Update an NVMe service
View NVMe subsystem controllers
Protocols NVMe subsystem-controllers endpoint overview
Retrieve NVMe subsystem controllers
Retrieve an NVMe subsystem controller
Manage NVMe subsystem maps
Protocols NVMe subsystem-maps endpoint overview
Retrieve NVMe subsystem maps
Create an NVMe subsystem map
Delete an NVMe subsystem map
Retrieve an NVMe subsystem map
Manage NVMe subsystems
Protocols NVMe subsystems endpoint overview
Retrieve NVMe subsystems
Create an NVMe subsystem
Retrieve NVMe subsystem hosts
Add NVMe subsystem hosts
Delete an NVMe subsystem host
Retrieve an NVMe subsystem host
Remove an NVMe subsystem
Retrieve an NVMe subsystem
Update an NVMe subsystem
Manage NVMe namespaces
Storage namespaces endpoint overview
Retrieve NVMe namespaces
Create an NVMe namespace
Delete an NVMe namespace
Retrieve an NVMe namespace
Update an NVMe namespace
Name-services
Name-services overview
Manage DNS configurations
Name-services dns endpoint overview
Retrieve DNS configurations for all SVMs
Create DNS domain and server configurations
Delete a DNS domain configuration
Retrieve DNS domain and server configurations
Update DNS domain and server configurations
Manage LDAP server configurations
Name-services LDAP endpoint overview
Retrieve an LDAP configuration for all SVMs
Create an LDAP configuration for an SVM
Delete the LDAP configuration for an SVM
Retrieve the LDAP configuration for an SVM
Update the LDAP configuration for an SVM
Manage name mappings for SVMs
Name-services name-mappings endpoint overview
Retrieve hostname mapping for all SVMs
Create the hostname mappings for an SVM
Delete the name mapping configuration
Retrieve the name mapping configuration for an SVM
Update the name mapping configuration for an SVM
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
Networking overview
Manage broadcast domains
Network Ethernet broadcast-domains endpoint overview
Retrieve broadcast domains for the entire cluster
Create a new broadcast domain
Delete a broadcast domain
Retrieve broadcast domain details
Update broadcast domain properties
Manage network Ethernet ports
Network Ethernet ports endpoint overview
Retrieve ports
Create a new VLAN or LAG
Delete a VLAN or LAG
Retrieve a physical port, VLAN, or LAG details
Update a port
Manage FC network interfaces
Network FC interfaces endpoint overview
Retrieve FC interfaces
Create an FC interface
Delete an FC interface
Retrieve an FC interface
Update an FC interface
Retrieve FC port information
Network FC ports endpoint overview
Retrieve FC ports
Retrieve an FC port
Update an FC port
Manage network IP interfaces
Network IP interfaces endpoint overview
Retrieve all IP interface details
Create a new cluster-scoped or SVM-scoped interface
Delete an IP interface
Retrieve details for an IP interface
Update an IP interface
Manage network IP routes
Network IP routes endpoint overview
Retrieve IP routes
Create a cluster-scoped or SVM-scoped static route
Delete an IP route
Retrieve details for an IP route
Manage network IP service policies
Network IP service-policies endpoint overview
Retrieve service policies
Retrieve a service policy
Manage network IPspaces
Network ipspaces endpoint overview
Retrieve IPspaces for a cluster
Create a new domain with unique IP addresses
Delete an IPspace object
Retrieve information about an IPspace
Update an IPspace object
SAN
SAN overview
Retrieve FC port information
Network FC logins endpoint overview
Retrieve FC logins
Retrieve an FC login
Manage FC WWPN aliases
Network FC wwpn-aliases endpoint overview
Retrieve FC WWPN aliases
Create an FC WWPN alias
Delete an FC WWPN alias
Retrieve an FC WWPN alias
Manage FC services for SVMs
Protocols SAN fcp services endpoint overview
Retrieve FC protocol services
Create an FC protocol service
Delete an FC protocol service
Retrieve an FC protocol service
Update an FC protocol service
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
Protocols SAN iSCSI credentials endpoint overview
Retrieve iSCSI credentials
Create iSCSI credentials
Delete iSCSI credentials
Retrieve specific iSCSI credentials
Update iSCSI credentials
Manage iSCSI services
Protocols SAN iSCSI services endpoint overview
Retrieve iSCSI services
Create an iSCSI service
Delete an iSCSI service
Retrieve an iSCSI service
Update an iSCSI service
View iSCSI sessions
Protocols SAN iSCSI sessions endpoint overview
Retrieve iSCSI sessions
Retrieve an iSCSI session
Manage SAN LUN maps
Protocols SAN lun-maps endpoint overview
Retrieve LUN maps
Create a LUN map
Delete a LUN map
Retrieve a LUN map
Manage LUNs
Storage luns endpoint overview
Retrieve LUNs
Create a LUN
Delete a LUN
Retrieve LUN properties or data
Update an existing LUN
SVM
SVM overview
Manage SVM peer permissions
SVM peer-permissions endpoint overview
Retrieve SVM peer permissions
Create an SVM peer permission
Delete SVM peer permissions
Retrieve an SVM peer permission instance
Update SVM peer permissions
Manage SVM peer relationships
SVM peers endpoint overview
Retrieve SVM peer relationships
Create a new SVM peer relationship
Delete an SVM peer relationship
Retrieve an SVM peer relationship instance
Update an SVM peer relationship
Manage SVMs
SVM svms endpoint overview
Retrieve SVMs and SVM properties
Create and provision an SVM
Delete an SVM
Retrieve SVM properties
Update SVM properties
Security
Security overview
Manage security-related accounts
Security accounts endpoint overview
Retrieve user accounts in the cluster
Create a new user account
Manage scoped user accounts
Security accounts owner.uuid name endpoint overview
Delete a user account
Retrieve a specific user account
Update a user account
View and update audit settings
Security audit endpoint overview
Retrieve the administrative audit settings for GET requests
Update the administrative audit settings for GET requests
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
Security audit messages endpoint overview
Retrieve the administrative audit log viewer
Manage LDAP server configuration
Security authentication cluster LDAP endpoint overview
Delete the LDAP configuration for the cluster
Retrieve the LDAP configuration for the cluster
Update the LDAP configuration for the cluster
Create the LDAP configuration for the cluster
Manage NIS configuration
Security authentication cluster NIS endpoint overview
Delete the NIS configuration for the cluster
Retrieve the NIS configuration for the cluster
Update the NIS configuration for the cluster
Create the NIS configuration for the cluster
Manage SAML service
Security authentication cluster saml-sp endpoint overview
Delete a SAML service provider configuration
Retrieve a SAML service provider configuration
Update a SAML service provider configuration
Create a SAML service provider configuration
Update the user account password
Security authentication password endpoint overview
Update the user account password
Manage security certificates
Security certificates endpoint overview
Retrieve security certificates
Create or install security certificates
Sign security certificates
Delete security certificates
Retrieve security certificates
Manage key managers
Security key-managers endpoint overview
Retrieve key managers
Create a key manager
Delete key managers
Retrieve key managers
Update 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
Security login messages endpoint overview
Retrieve login banner and messages of the day
Retrieve login messages configuration by UUID
Update login messages configuration
Manage security roles
Security roles endpoint overview
Retrieve a list of roles configured in the cluster
Create a new cluster-scoped or SVM-scoped role
View or delete a role
Security roles owner.uuid name endpoint overview
Delete a role
Retrieve the details of a role
Manage role privilege details
Security roles owner.uuid name privileges endpoint overview
Retrieve privilege details of the specified role
Add a privilege tuple to an existing role
Manage role privilege path
Security roles owner.uuid name privileges path endpoint overview
Delete a privilege tuple from the role
Retrieve the access level for a REST API path or command/command directory path for a role
Update the access level for a REST API path or command/command directory path
SnapMirror
SnapMirror overview
Manage SnapMirror policies
SnapMirror policies endpoint overview
Retrieve SnapMirror async and sync policy types
Create a SnapMirror policy
Delete a SnapMirror policy
Retrieve a specific SnapMirror policy
Update the SnapMirror policy
Manage SnapMirror relationships
SnapMirror relationships endpoint overview
Retrieve information for SnapMirror relationships
Create a SnapMirror relationship
Delete a SnapMirror relationship
Retrieve a SnapMirror relationship
Update a SnapMirror relationship
Manage SnapMirror relationship tranfers
SnapMirror relationships relationship.uuid transfers endpoint overview
Retrieve ongoing SnapMirror transfers for a relationship
Start a SnapMirror transfer operation
Retrieve attributes of an ongoing SnapMirror transfer
Cancel an ongoing SnapMirror transfer
Storage
Storage overview
Retrieve or create a collection of storage aggregates
Storage aggregates endpoint overview
Retrieve a collection of aggregates for an entire cluster
Create a collection of aggregates for an entire cluster
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
Storage aggregates aggregate.uuid plexes endpoint overview
Retrieve a collection of plexes for an aggregate
Retrieve a plex specified by the aggregate UUID and plex name
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
Storage disks endpoint overview
Retrieve a collection of disks
Retrieve a specific disk
Create a clone of the file
Manage FlexCache volumes
Storage flexcache flexcaches endpoint overview
Retrieve a FlexCache volume in the cluster
Create a FlexCache volume in the cluster
Delete a FlexCache volume
Retrieve attributes of the FlexCache volume in the cluster
Manage storage FlexCache origin volumes
Storage flexcache origins endpoint overview
Retrieve the origin of a FlexCache volume in the cluster
Retrieve attributes of the origin of a FlexCache volume in the cluster
Manage storage ports
Storage ports endpoint overview
Retrieve storage ports
Retrieve a storage port
Manage QoS policies
Storage Qos policies endpoint overview
Retrieve QoS policies
Create a QoS policy
Delete a QoS policy
Retrieve a QoS policy
Update a QoS policy
Manage storage qtrees
Storage qtrees endpoint overview
Retrieve qtrees
Create a qtree in a FlexVol or FlexGroup volume
Delete a qtree
Retrieve qtree properties
Update properties for a qtree
Storage quota
Storage quota endpoint overview
Manage storage quota reports
Storage quota reports endpoint overview
Retrieve the quota report records for all FlexVol and FlexGroup volumes
Retrieve a specific quota report record
Manage storage quota policy rules
Storage quota rules endpoint overview
Retrieve quota policy rules for all FlexVol and FlexGroup volumes
Create a quota policy rule for a FlexVol or a FlexGroup volume
Delete a quota policy rule
Retrieve quota policy rule properties
Update quota policy rule properties
Manage shelves
Storage shelves endpoint overview
Retrieve shelves
Retrieve a shelf
Manage Snapshot copy policies
Storage snapshot-policies endpoint overview
Retrieve Snapshot copy policies
Delete a Snapshot copy policy
Retrieve Snapshot copy policy details
Update a Snapshot copy policy
Create a Snapshot copy policy
Manage storage volumes
Storage volumes endpoint overview
Retrieve volumes
Create a volume on an SVM and storage aggregates
Delete a volume
Retrieve a volume
Update volume attributes
Retrieve historical performance metrics for a volume
Manage volume Snapshot copies
Storage volumes volume.uuid snapshots endpoint overview
Retrieve volume Snapshot copies
Create a volume Snapshot copy
Delete a volume Snapshot copy
Retrieve volume Snapshot copy details
Update a volume Snapshot copy
Support
Support overview
Manage AutoSupport configuration
Support AutoSupport endpoint overview
Retrieve the AutoSupport configuration
Update AutoSupport configuration for an entire cluster
Manage AutoSupport messages
Support AutoSupport messages endpoint overview
Retrieve AutoSupport message history
Create and send an AutoSupport message
Manage cluster configuration backup information
Support configuration-backup endpoint overview
Retrieve cluster configuration backup information
Update cluster configuration backup information
Manage EMS configuration
Support EMS endpoint overview
Retrieve EMS configuration
Update EMS configuration
Manage event destinations
Support EMS destinations endpoint overview
Retrieve a collection of event destinations
Create an event destination
Manage an event destination instance
Support EMS destinations name endpoint overview
Delete an event destination
Retrieve an event destination
Update an event destination
Retrieve events
Support EMS events endpoint overview
Retrieve observed events
Create or retrieve event filters
Support EMS filters endpoint overview
Retrieve event filters
Create an event filter
Manage event filters
Support EMS filters name endpoint overview
Delete an event filter
Retrieve an event filter
Update an event filter
Create or retrieve filter rules
Support EMS filters name rules endpoint overview
Retrieve event filter rules
Create an event filter rule
Manage event filter rules
Support EMS filters name rules index endpoint overview
Delete an event filter rule
Retrieve an event filter rule
Update an event filter rule
Manage the EMS event catalog
Support EMS messages endpoint overview
Retrieve event catalog definitions
Legal notices