ONTAP 9.16.1 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 snapshots
Create an application component snapshot
Delete an application component snapshot
Retrieve a snapshot for a specific application component
Restore an application component snapshot
Retrieve an application component
Manage application snapshots
Application applications application.uuid snapshots endpoint overview
Retrieve an application snapshot
Create an application snapshot
Delete an application snapshot
Retrieve an application snapshot
Restore an application snapshot
Delete an application and all associated data
Retrieve an application
Update application properties
Manage application consistency groups
Application consistency-groups endpoint overview
Retrieve details of a collection or consistency group
Create a consistency group
Delete a consistency group
Retrieve a consistency group
Update a consistency group
Retrieve consistency group metrics
Application consistency-groups consistency_group.uuid metrics endpoint overview
Retrieve the historical performance and capacity metrics for a consistency group
Manage application consistency group snapshots
Application consistency-groups consistency_group.uuid snapshots endpoint overview
Retrieve consistency group snapshots
Create a consistency group snapshot
Delete a consistency group snapshot
Retrieve a consistency group snapshot
Complete a consistency group snapshot operation
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
Retrieve cluster counter tables
Cluster counter tables endpoint overview
Retrieve counter tables with schema definitions
Retrieve counter rows
Retrieve a counter row
Retrieve counter table details
Manage cluster firmware history
Cluster firmware history endpoint overview
Retrieve history details for firmware update requests
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
Retrieve capacity pool licenses
Cluster licensing capacity-pools endpoint overview
Retrieve capacity pools
Retrieve capacity pool information
Manage cluster license managers
Cluster licensing license-managers endpoint overview
Retrieve license managers
Retrieve the license manager information
Update the license manager configuration
Manage cluster licensing
Cluster licensing licenses endpoint overview
Retrieve license packages
Install one or more feature licenses
Delete a license
Retrieve a license package
Manage cluster mediators
Cluster mediators endpoint overview
Retrieve ONTAP Mediators configured in the cluster
Create and connect an ONTAP Mediator
Delete an ONTAP Mediator
Retrieve the ONTAP Mediator state and configuration
Retrieve historical performance metrics for the cluster
View and manage MetroCluster configurations
Cluster MetroCluster endpoint overview
Retrieve MetroCluster status and configuration details
Initiate a switchover, heal, or switchback operation
Set up a MetroCluster configuration
Display MetroCluster diagnostics
Cluster MetroCluster diagnostics endpoint overview
Retrieve diagnostic operation results for a MetroCluster configuration
Start MetroCluster diagnostics or set up a periodic diagnostic schedule
Manage MetroCluster DR groups
Cluster MetroCluster dr-groups endpoint overview
Retrieve all DR groups in a MetroCluster IP configuration
Create a new DR group in a MetroCluster IP configuration
Remove a DR group from a MetroCluster IP configuration
Retrieve DR group information using the DR group ID
View and update MetroCluster interconnects
Cluster MetroCluster interconnects endpoint overview
Retrieve interconnect adapter information for nodes in MetroCluster
Retrieve information about a MetroCluster interconnect for a partner type and adapter
Update a MetroCluster interconnect interface
Retrieve MetroCluster node configurations
Cluster MetroCluster nodes endpoint overview
Retrieve MetroCluster nodes and configurations
Retrieve the node configuration in MetroCluster
Retrieve MetroCluster operations
Cluster MetroCluster operations endpoint overview
Retrieve MetroCluster operations on the local cluster
Retrieve information about a MetroCluster operation
Retrieve MetroCluster SVMs
Cluster MetroCluster svms endpoint overview
Retrieve configuration information for all SVM pairs in a MetroCluster configuration
Retrieve configuration information for an SVM
Manage cluster nodes
Cluster nodes endpoint overview
Retrieve the nodes in a cluster
Add a node or nodes to a cluster
Delete a node from a cluster
Retrieve node information
Update node information
Retrieve node historical performance metrics
Cluster NTP
Cluster NTP endpoint overview
Manage cluster NTP keys
Cluster NTP keys endpoint overview
Retrieve the NTP symmetric authentication keys
Create an NTP symmetric authentication key entry
Delete an NTP key
Retrieve NTP symmetric authentication key details
Update NTP symmetric authentication key details
Manage cluster NTP servers
Cluster NTP servers endpoint overview
Retrieve external NTP time servers
Validate an external NTP time server
Delete an external NTP server
Retrieve an external NTP server configuration
Update an NTP server configuration after validation
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
Retrieve environment sensors
Manage environment sensors
Cluster sensors node.uuid index endpoint overview
Retrieve the environment sensors for a node
Manage cluster software
Cluster software endpoint overview
Retrieve the cluster software profile
Update the cluster software version
Retrieve software or firmware download status
Download a software or firmware package
Retrieve software installation requests history details
Retrieve cluster software packages
Delete a software package from the cluster
Retrieve the software package information
Upload a software or firmware package located on the local file system
View and update cluster web configurations
Cluster web endpoint overview
Retrieve the web services configuration
Update the web services configuration
View tags used for resources
Resource-tags endpoint overview
Retrieve the tags currently used for resources
Manage resource tags
Resource-tags resource_tag.value resources endpoint overview
Retrieve the resources for a tag
Create a new tag for a resource
Delete a tag for a resource
Retrieve a resource for a tag
Retrieve a resource tag
NAS
NAS overview
Manage Active Directory accounts
Protocols active-directory endpoint overview
Retrieve Active Directory accounts for all SVMs
Create an Active Directory account for an SVM
Manage Active Directory accounts for an SVM
Protocols active-directory svm.uuid endpoint overview
Delete an Active Directory account for an SVM
Retrieve an Active Directory account for an SVM
Modify an Active Directory account for an SVM
Manage Active Directory domain controllers
Protocols active-directory svm.uuid preferred-domain-controllers endpoint overview
Retrieve an Active Directory preferred DC configuration for an SVM
Create an Active Directory preferred DC configuration for an SVM
Delete an Active Directory preferred DC configuration for an SVM and domain
Retrieve an Active Directory preferred DC configuration for an SVM and domain
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 S3 audit configurations
Protocols audit svm.uuid object-store endpoint overview
Delete an S3 audit configuration
Retrieve an S3 audit configurations
Update an S3 audit configuration for an SVM
Create an S3 audit configuration
View CIFS connection information
Protocols CIFS connections endpoint overview
Retrieve the CIFS connection information for all SVMs
View CIFS domain-related information
Protocols CIFS domains endpoint overview
Retrieve the CIFS domain-related information of all SVMs
Manage CIFS domain-related information
Protocols CIFS domains svm.uuid endpoint overview
Retrieve the CIFS domain-related information for an SVM
Modify the CIFS domain-related information for an SVM
Manage CIFS DC configuration
Protocols CIFS domains svm.uuid preferred-domain-controllers endpoint overview
Retrieve the CIFS domain preferred DC configuration for an SVM
Create the CIFS domain preferred DC configuration for an SVM
Delete the CIFS domain preferred DC configuration for an SVM and domain
Retrieve the CIFS domain preferred DC configuration for an SVM and domain
Retrieve unapplied group policy objects for all SVMs
Retrieve unapplied group policy objects for an SVM
Create a background task to update the GPO settings for an SVM
Retrieve applied central access policies for an SVM
Retrieve an applied central access policy for an SVM
Retrieve applied central access rules for an SVM
Retrieve an applied central access rule for an SVM
View group policy objects
Protocols CIFS group-policies svm.uuid objects endpoint overview
Retrieve applied group policy objects for an SVM
Retrieve an applied group policy object for an SVM
Retrieve applied restricted group policies for an SVM
Retrieve an applied restricted group policy 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 local groups
Protocols CIFS local-groups endpoint overview
Retrieve local groups for all SVMs
Create the local group configuration for an SVM
Delete a local group configuration for an SVM
Retrieve local group information for a group and SVM
Update local group information for a group in an SVM
Manage local group members
Protocols CIFS local-groups svm.uuid local_cifs_group.sid members endpoint overview
Delete local users or Active Directory users and groups from a local group and SVM
Retrieve local users and Active Directory users and groups that belong to a local group and SVM
Add local users and Active Directory users and groups to a local group and SVM
Delete a local user, or Active Directory user or group from a local group and SVM
Retrieve a local user, Active Directory user or group belonging to a local group and SVM
Manage local users
Protocols CIFS local-users endpoint overview
Retrieve local users for all SVMs
Create the local user configuration for an SVM
Delete the local user configuration for an SVM
Retrieve the local user information for a user and SVM
Update the local user information for a user and SVM
View NetBIOS information
Protocols CIFS netbios endpoint overview
Retrieve NetBIOS information
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
Retrieve CIFS protocol historical performance metrics for an SVM
View CIFS active file sessions
Protocols CIFS session files endpoint overview
Retrieve CIFS open files
Close open files identified by SVM
Retrieve a CIFS open file
View CIFS active sessions
Protocols CIFS sessions endpoint overview
Retrieve CIFS session information for all SVMs
Delete SMB session information for an SVM node
Retrieve SMB session information for an SMB connection in an SVM node
View and update shadow copy information
Protocols CIFS shadow-copies endpoint overview
Retrieve shadow copies
Retrieve a shadow copy
Update a shadow copy
Retrieve shadow copy sets
Retrieve a shadow copy set
Update a shadow copy set
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
Perform bulk import for CIFS user groups
Protocols CIFS users-and-groups bulk-import svm.uuid endpoint overview
Retrieve import operation status for CIFS local users, groups, and group memberships
Upload the bulk-import status of an SVM to a URI
Load CIFS local users, groups and group membership files from a URL
Manage CIFS user group privileges
Protocols CIFS users-and-groups privileges endpoint overview
Retrieve privileges for all local, or Active Directory users or groups and SVMs
Add privileges to a local, or Active Directory user or group and SVM
Retrieve privileges for a local, or Active Directory user or group and SVM
Update privileges for a local, or Active Directory user or group and SVM
View file security permissions
Protocols file-security effective-permissions svm.uuid path endpoint overview
Retrieve effective security permissions on a file
Manage file security permissions and audit policies
Protocols file-security permissions svm.uuid path endpoint overview
Remove all SLAG ACLs for a path
Retrieve file permissions
Update the SD information
Apply an SD to a path
Add a new SACL or DACL ACE
Delete a SACL or DACL ACL
Update SACLs or DACLs
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
View and update FPolicy server configuration
Protocols fpolicy svm.uuid connections endpoint overview
Retrieve the status of FPolicy servers
Retrieve the status of an FPolicy server
Update the FPolicy server status
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 the 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 FPolicy persistent store configuration
Protocols fpolicy svm.uuid persistent-stores endpoint overview
Retrieve the FPolicy persistent store configurations for an SVM
Create an FPolicy persistent store configuration for an SVM
Delete an FPolicy persistent store configuration for an SVM
Retrieve an FPolicy persistent store configuration for an SVM
Update an FPolicy persistent store configuration for an SVM
Manage SVM FPolicy configuration
Protocols fpolicy svm.uuid policies endpoint overview
Retrieve an FPolicy configuration for an SVM
Create an FPolicy configuration for an SVM
Delete an FPolicy configuration for an SVM
Retrieve an FPolicy configuration for an SVM
Update an FPolicy configuration for an SVM
View lock details
Protocols locks endpoint overview
Retrieve lock details
Delete locks for a parameter
Retrieve the lock for a specific UUID
View NFS client information
Protocols NFS connected-client-maps endpoint overview
Retrieve NFS client information
View and update NFS client settings
Protocols NFS connected-client-settings endpoint overview
Retrieve the NFS connected-client cache settings for a cluster
Update NFS connected-client cache settings properties
View NFS connected clients
Protocols NFS connected-clients endpoint overview
Retrieve the NFS 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 the NFS configuration for SVMs
Create an NFS configuration for an SVM
Delete NFS configuration for an SVM
Retrieve NFS configuration for an SVM
Update NFS configuration for an SVM
Retrieve NFS protocol historical performance metrics
Manage NFS over TLS interface configuration details
Protocols NFS tls interfaces endpoint overview
Retrieve NFS over TLS interface configurations
Retrieve an NFS over TLS interface configuration
Update the properties of an NFS over TLS interface
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
Retrieve Vscan events
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 the Vscan scanner-pool configuration
Retrieve the Vscan scanner-pool configuration for an SVM
Update the Vscan scanner-pool configuration for an SVM
NDMP
NDMP overview
Manage NDMP mode
Protocols NDMP endpoint overview
Retrieve the current NDMP mode
Update the NDMP mode
Manage NDMP node configurations
Protocols NDMP nodes endpoint overview
Retrieve the NDMP node configurations for all nodes
Retrieve the NDMP node configuration for a node
Update the NDMP node configuration for a node
Manage NDMP session configurations
Protocols NDMP sessions endpoint overview
Retrieve NDMP sessions
Delete an NDMP session
Retrieve NDMP session details
Manage NDMP configuration of SVM
Protocols NDMP svms endpoint overview
Retrieve NDMP configurations for all SVMs
Retrieve NDMP configuration for an SVM
Update NDMP configuration for an SVM
Generate the NDMP user password
Protocols NDMP svms svm.uuid passwords user endpoint overview
Generate and retrieve the password for an NDMP user
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
Retrieve NVMe protocol historical performance metrics
Retrieve historical performance metrics for the NVMe protocol service of an SVM for a specific time
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
Retrieve historical performance metrics for an NVMe namespace
Retrieve historical performance metrics for an NVMe namespace for a specific time
Delete an NVMe namespace
Retrieve an NVMe namespace
Update an NVMe namespace
Name-services
Name-services overview
Manage group membership cache settings
Name-services cache group-membership settings endpoint overview
Retrieve group membership cache settings
Retrieve a group membership cache setting for an SVM
Update a group membership cache setting
Manage host cache settings
Name-services cache host settings endpoint overview
Retrieve host cache settings
Retrieve a host cache setting for an SVM
Update a host cache setting
Manage netgroup cache settings
Name-services cache netgroup settings endpoint overview
Retrieve netgroup cache settings
Retrieve a netgroup cache setting for an SVM
Update a netgroup cache setting
Manage global cache settings
Name-services cache setting endpoint overview
Retrieve a global name service cache setting
Update a global name service cache setting
Manage UNIX group cache settings
Name-services cache unix-group settings endpoint overview
Retrieve UNIX group cache settings
Retrieve a UNIX group cache setting for an SVM
Update UNIX group cache settings
Manage UNIX user cache settings
Name-services cache unix-user settings endpoint overview
Retrieve UNIX user cache settings
Retrieve UNIX user cache settings for an SVM
Update a UNIX user cache setting
Manage DNS configurations
Name-services dns endpoint overview
Retrieve DNS configurations for all SVMs
Create DNS domain and server configurations
Delete the DNS domain configuration for an SVM
Retrieve the DNS domain and server configuration for an SVM
Update the DNS domain and server configuration for an SVM
View host records
Name-services host-record svm.uuid host endpoint overview
Retrieve an IP address of a hostname
Manage LDAP server configurations
Name-services LDAP endpoint overview
Retrieve the LDAP configuration for all SVMs
Create the 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 LDAP schemas
Name-services ldap-schemas endpoint overview
Retrieve all LDAP schemas
Create an LDAP schema
Delete an existing schema
Retrieve the LDAP schema details for an owner and schema
Update the LDAP schema details for an owner and schema
Manage local mapping for hostnames
Name-services local-hosts endpoint overview
Retrieve IP to hostname mappings for all SVMs in a cluster
Create a new IP to hostname mapping
Delete an existing host object
Retrieve a hostname mapping for an SVM
Update a hostname mapping for an SVM
Manage name mappings for SVMs
Name-services name-mappings endpoint overview
Retrieve the hostname mapping for all SVMs
Create 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
Display netgroup file details
Name-services netgroup-files svm.uuid endpoint overview
Delete a netgroup file for an SVM
Retrieve the netgroup file details
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
Manage UNIX group configurations
Name-services unix-groups endpoint overview
Retrieve UNIX groups for all SVMs
Create a local UNIX group configuration for an SVM
Delete a UNIX group configuration for an SVM
Retrieve UNIX group information for a group and SVM
Update UNIX group information for a group in an SVM
Manage UNIX group users
Name-services unix-groups svm.uuid unix_group.name users endpoint overview
Retrieve users for a UNIX group and SVM
Add users to a UNIX group and SVM
Delete a user from a UNIX group
Retrieve users for a UNIX group and SVM
Manage UNIX user configurations
Name-services unix-users endpoint overview
Retrieve all UNIX users for all SVMs
Create a local UNIX user configuration for an SVM
Delete a UNIX user configuration for an SVM
Retrieve UNIX user information for a user and SVM
Update UNIX user information for a user and 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
Retrieve historical port performance metrics
Retrieve network Ethernet switch ports
Network Ethernet switch ports endpoint overview
Retrieve Ethernet switch ports
Retrieve an Ethernet switch port
Manage Ethernet switches
Network Ethernet switches endpoint overview
Retrieve Ethernet switches attached to a chassis
Create an Ethernet switch
Delete an Ethernet switch
Retrieve Ethernet switch details
Update an Ethernet switch
Retrieve FC fabrics
Network FC fabrics endpoint overview
Retrieve FC fabrics
Retrieve FC fabric switches
Retrieve an FC switch
Retrieve FC fabric zones
Retrieve an FC fabric zone
Retrieve an FC fabric
Manage FC network interfaces
Network FC interfaces endpoint overview
Retrieve FC interfaces
Create an FC interface
Retrieve historical performance metrics for an FC interface
Retrieve historical performance metrics for an FC interface for a specific time
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 historical performance metrics for an FC port
Retrieve historical performance metrics for an FC port for a specific time
Retrieve an FC port
Update an FC port
Manage HTTP proxy configuration
Network http-proxy endpoint overview
Retrieve HTTP proxy configurations for all SVMs and cluster IPspaces
Create an HTTP proxy configuration for an SVM or cluster IPspace
Delete HTTP proxy configuration for an SVM or cluster IPspace
Display HTTP proxy server, port, and IPspace information for an SVM or cluster IPspace
Update proxy server, port, username, and password parameters
Manage BGP peer groups
Network IP BGP peer-groups endpoint overview
Retrieve all BGP peer group details for VIP
Create a new BGP peer group for VIP
Delete a BGP peer group for VIP
Retrieve details of a BGP peer group for VIP
Update a BGP peer group for VIP
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
Retrieve interface historical performance metrics
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
Create a service policy for network interfaces
Delete a service policy for network interfaces
Retrieve a service policy
Update a service policy for network interfaces
Manage network IP subnets
Network IP subnets endpoint overview
Retrieve details for all subnets
Create a new named subnet
Delete an IP subnet
Retrieve IP subnet details
Update an IP subnet
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
Object-store
Manage S3 buckets
Protocols S3 buckets endpoint overview
Retrieve all S3 buckets for all SVMs
Create the S3 bucket configuration for an SVM
Delete the S3 bucket configuration for an SVM
Retrieve the S3 bucket configuration for an SVM
Update the S3 bucket configuration for an SVM
Manage protocols S3 services
Protocols S3 services endpoint overview
Retrieve the S3 server configuration for all SVMs
Create S3 server, users, and buckets configurations
Delete the S3 server configuration for an SVM
Retrieve the S3 server configuration for an SVM
Update the S3 server configuration for an SVM
Manage S3 service bucket configuration
Protocols S3 services svm.uuid buckets endpoint overview
Retrieve the S3 bucket configurations for an SVM
Create an S3 bucket configuration for an SVM
Delete an S3 bucket configuration for an SVM
Retrieve an S3 bucket for an SVM
Update an S3 bucket configuration for an SVM
Manage S3 bucket lifecycle management rules
Protocols S3 services svm.uuid buckets s3_bucket.uuid rules endpoint overview
Retrieve S3 lifecycle rules for a bucket
Create the S3 bucket lifecycle rule configuration
Delete an S3 bucket lifecycle rule
Retrieve all S3 lifecycle rules for a bucket
Update the S3 bucket lifecycle rule configuration
Manage S3 bucket snapshots
Protocols S3 services svm.uuid buckets s3_bucket.uuid snapshots endpoint overview
Retrieve a collection of S3 bucket snapshots
Create an S3 bucket snapshot
Delete an S3 bucket snapshot
Retrieve details of a specific S3 bucket snapshot
Manage S3 service group configuration
Protocols S3 services svm.uuid groups endpoint overview
Retrieve an S3 group configuration
Create an S3 group configuration
Delete an S3 group configuration for an SVM
Retrieve an S3 group configuration for an SVM
Update an S3 group configuration for an SVM
Retrieve S3 protocol historical performance metrics
Manage S3 service policies
Protocols S3 services svm.uuid policies endpoint overview
Retrieve the S3 policies in an SVM configuration
Create an S3 policy configuration
Delete an S3 policy configuration
Retrieve an S3 policy configuration
Update an S3 policy configuration
Manage S3 service users
Protocols S3 services svm.uuid users endpoint overview
Retrieve the SVM configuration for an S3 user
Create an S3 user configuration
Delete an S3 user configuration
Retrieve the S3 user configuration for an SVM
Update an S3 user configuration
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
Retrieve historical performance metrics for the FC protocol service of an SVM
Retrieve historical performance metrics for the FC protocol service of an SVM for a specific time
Manage SAN igroups
Protocols SAN igroups endpoint overview
Retrieve initiator groups
Create an initiator group
Retrieve nested initiator groups of an initiator group
Add nested initiator groups to an initiator group
Remove a nested initiator group from an initiator group
Retrieve a nested initiator group of 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
Update an initiator
Delete an initiator group
Retrieve an initiator group
Update an initiator group
Manage SAN initiators
Protocols SAN initiators endpoint overview
Retrieve initiators
Retrieve an initiator
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
Retrieve historical performance metrics for the iSCSI protocol of an SVM
Retrieve historical performance metrics for the iSCSI protocol service of an SVM for a specific time
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
Add, remove, or discover LUN map reporting nodes
Protocols SAN lun-maps lun.uuid igroup.uuid reporting-nodes endpoint overview
Retrieve LUN map reporting nodes
Add a reporting node and its HA partner to a LUN map
Remove a reporting node and its HA partner from a LUN map
Retrieve a LUN map reporting node
Manage SAN portsets
Protocols SAN portsets endpoint overview
Retrieve portsets
Create a portset
Retrieve portset network interfaces
Add portset network interfaces
Delete portset network interfaces
Retrieve specific portset network interfaces
Delete a portset
Retrieve a portset
Manage SAN vVol bindings
Protocols SAN vvol-bindings endpoint overview
Retrieve vVol bindings
Create a vVol binding
Delete a vVol binding
Retrieve a vVol binding
Manage LUNs
Storage luns endpoint overview
Retrieve LUNs
Create a LUN
Delete a LUN
Retrieve LUN properties or data
Update an existing LUN
Manage LUN attributes
Storage luns lun.uuid attributes endpoint overview
Retrieve LUN attributes
Add an attribute to a LUN
Delete a LUN attribute
Retrieve a LUN attribute
Update a LUN attribute value
Retrieve historical performance metrics for a LUN
Retrieve historical performance metrics for a LUN for a specific time
SVM
SVM overview
Manage SVM migration
SVM migrations endpoint overview
Retrieve the SVM migration status
Create an SVM migration operation
Retrieve the transfer status of volumes in an SVM
Retrieve the volume transfer status for a volume
Delete SVM migrations
Retrieve the migration status for an SVM
Update actions performed during an SVM migration
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
Retrieve clients
SVM svms svm.uuid top-metrics clients endpoint overview
List clients with the most I/O activity
Retrieve directories
SVM svms svm.uuid top-metrics directories endpoint overview
List directories with the most I/O activity
Retrieve files
SVM svms svm.uuid top-metrics files endpoint overview
List files with the most I/O activity
Retrieve users
SVM svms svm.uuid top-metrics users endpoint overview
List users with the most I/O activity
Manage web services security configuration
SVM svms svm.uuid web endpoint overview
Retrieve the web services security configuration
Update the web services security configuration
Security
Security overview
Manage security-related operations
Security endpoint overview
Retrieve information about security configured on the cluster
Update the software FIPS mode or enable conversion of non-encrypted metadata volumes non-NAE aggregates
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
Manage the anti-ransomware package
Security anti-ransomware endpoint overview
Retrieve the anti-ransomware version of the nodes in the cluster
Update the anti-ransomware package on the cluster
View suspect files generated by anti-ransomware
Security anti-ransomware suspects endpoint overview
Retrieve information on the suspects generated by anti-ransomware analytics
Delete suspect files
Security anti-ransomware suspects volume.uuid endpoint overview
Clear suspect files of a volume
View and update audit settings
Security audit endpoint overview
Retrieve administrative audit settings for GET requests
Update 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 data SVM account information
Security authentication cluster ad-proxy endpoint overview
Delete a data SVM configured as a tunnel
Retrieve SVM information configured as an Active Directory domain-tunnel
Update a data SVM configured as a tunnel
Configure a data SVM as a proxy
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
View and update OAuth 2.0 status
Security authentication cluster oauth2 endpoint overview
Retrieve the OAuth 2.0 status
Update the OAuth 2.0 status
View and create OAuth 2.0 configurations
Security authentication cluster oauth2 clients endpoint overview
Retrieve all OAuth 2.0 configurations
Create the OAuth 2.0 configuration
View and delete an OAuth 2.0 configuration
Security authentication cluster oauth2 clients name endpoint overview
Delete an OAuth 2.0 configuration
Retrieve an OAuth 2.0 configuration with the specified name
Manage SAML service
Security authentication cluster saml-sp endpoint overview
Delete an SAML service provider configuration
Retrieve an SAML service provider configuration
Update an SAML service provider configuration
Create an SAML service provider configuration
View and create Duo groups
Security authentication duo groups endpoint overview
Retrieve the configured groups
Create a Duo group
Manage Duo groups configured for an SVM or cluster
Security authentication duo groups owner.uuid name endpoint overview
Delete a Duo group configured for an SVM or cluster
Retrieve the Duo group configured for an SVM or cluster
Update a Duo group configured for an SVM or cluster
View and create a Duo profile
Security authentication duo profiles endpoint overview
Retrieve configured Duo profiles
Create a Duo profile
Manage Duo profiles for an SVM or cluster
Security authentication duo profiles owner.uuid endpoint overview
Delete a Duo profile for an SVM or cluster
Retrieve a Duo profile configured for an SVM or cluster
Update a Duo profile configured for an SVM or cluster
Update the user account password
Security authentication password endpoint overview
Update the user account password
Manage authentication keys (for admins)
Security authentication publickeys endpoint overview
Retrieve public keys configured for user accounts
Create a public key for a user account
Manage authentication keys (end-users)
Security authentication publickeys owner.uuid account.name index endpoint overview
Delete a public key for a user account
Retrieve public keys configured for a user account
Update a public key for a user account
Manage AWS KMS
Security aws-kms endpoint overview
Retrieve all AWS KMS instances configured for all clusters and SVMs
Configure the AWS KMS configuration for an SVM
Re-key or re-version an AWS KMS key encryption key for AWS KMS
Re-key SVM KEK for an AWS KMS
Restore keys for an SVM from a configured AWS KMS
Delete an AWS KMS configuration
Retrieve an AWS KMS configuration
Update an AWS KMS configuration
Manage Azure Key Vaults
Security azure-key-vaults endpoint overview
Retrieve AKVs configured for all clusters and SVMs
Create an AKV configuration for all clusters and SVMs
Re-key the external key in the key hierarchy
Delete an AKV configuration
Retrieve the AKV configuration for an SVM specified by the UUID
Update the AKV configuration
Re-key the internal key in the key hierarchy for an SVM
Restore keys for an SVM from a configured AKV
Create a certificate signing request
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 external-role-mapping entries
Security external-role-mappings endpoint overview
Retrieve all external-role-mapping entries
Create an external-role-mapping entry
Delete an external-role-mapping entry
Retrieve an external-role-mapping entry
Update an external-role-mapping entry
Manage Google Cloud KMS
Security gcp-kms endpoint overview
Retrieve a Google Cloud KMS configurations for all clusters and SVMs
Create a Google Cloud KMS configuration for an SVM
Re-key the external key in the key hierarchy for an SVM
Delete a Google Cloud KMS configuration
Retrieve the Google Cloud KMS configuration
Update the Google Cloud KMS configuration
Re-key the internal key in the key hierarchy for an SVM
Restore keys for an SVM from a Google Cloud KMS
Manage group-to-role mapping entries
Security group role-mappings endpoint overview
Retrieve all group-to-role mapping entries
Create a group-to-role mapping entry
Delete a group-to-role mapping entry
Retrieve a group-to-role mapping entry
Update a configured group role-mapping entry
Manage group configurations
Security groups endpoint overview
Retrieve all group entries
Create a group entry
Delete a group entry
Retrieve a group entry
Update configured group information
View and update IPsec configuration
Security IPsec endpoint overview
Retrieve an IPsec configuration
Update an IPsec configuration
Manage IPsec security certificates
Security IPsec ca-certificates endpoint overview
Retrieve IPsec CA certificates configured for the cluster and all SVMs
Add a CA certificate to IPsec
Delete a CA certificate with the specified UUID from IPsec
Retrieve a CA certificate configured for IPpsec
Manage IPsec policies
Security IPsec policies endpoint overview
Retrieve IPsec policies
Create an IPsec policy
Delete an IPsec policy
Retrieve an IPsec policy
Update an IPsec policy
View IPsec security associations
Security IPsec security-associations endpoint overview
Retrieve IPsec and IKE security associations
Retrieve an IPsec or IKE security association
View and update key manager configurations
Security key-manager-configs endpoint overview
Retrieve key manager configurations
Update key manager configurations
Manage key managers
Security key-managers endpoint overview
Retrieve key managers
Create a key manager
Delete key managers
Retrieve key managers
Update key managers
Manage authentication keys
Security key-managers security_key_manager.uuid auth-keys endpoint overview
Retrieve authentication keys associated with the admin SVM
Create an authentication key
Delete an authentication key
List all authentication keys associated with the admin SVM
View security key managers
Security key-managers security_key_manager.uuid keys node.uuid key-ids endpoint overview
Retrieve key manager configurations
Retrieve key management key information for specified keys
Retrieve and restore unrestored keys
Migrate SVM keys between security 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
Manage keystores
Security key-stores endpoint overview
Retrieve keystores
Delete an inactive keystore configuration
Retrieve keystore configuration details with the specified UUID
Enable a keystore configuration
Manage security login messages
Security login messages endpoint overview
Retrieve the login banner and messages of the day
Retrieve a login message configuration by UUID
Update a login message configuration
View and create TOTP profiles
Security login totps endpoint overview
Retrieve TOTP profiles configured for user accounts
Create the TOTP profile for a user account
Manage TOTP profiles
Security login totps owner.uuid account.name endpoint overview
Delete the TOTP profile for a user account
Retrieve the TOTP profile for a user account
Update a TOTP profile for a user account
Manage the multi-admin-verify global setting
Security multi-admin-verify endpoint overview
Retrieve a multi-admin-verify configuration
Modify a multi-admin-verify configuration
View and create multi-admin-verify approval groups
Security multi-admin-verify approval-groups endpoint overview
Retrieve multi-admin-verify approval groups
Create a multi-admin-verify approval group
Manage multi-admin-verify approval groups
Security multi-admin-verify approval-groups owner.uuid name endpoint overview
Delete a multi-admin-verify approval group
Retrieve a multi-admin-verify approval group
Update a multi-admin-verify approval group
Manage multi-admin-verify approval requests
Security multi-admin-verify requests endpoint overview
Retrieve multi-admin-verify requests
Create a multi-admin-verify request
Manage a multi-admin-verify approval request
Security multi-admin-verify requests index endpoint overview
Delete a multi-admin-verify request
Retrieve a multi-admin-verify request
Update a multi-admin-verify request
Manage multi-admin-verify rules
Security multi-admin-verify rules endpoint overview
Retrieve multi-admin-verify rules
Create a multi-admin-verify rule
Manage a multi-admin-verify rule
Security multi-admin-verify rules owner.uuid operation endpoint overview
Delete a multi-admin-verify rule
Retrieve a multi-admin-verify rule
Update a multi-admin-verify rule
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
Manage SSH server
Security SSH endpoint overview
Retrieve cluster SSH server ciphers, MAC algorithms, key exchange algorithms, and connection limits
Update the SSH server setting for a cluster
View SSH SVMs
Security SSH svms endpoint overview
Retrieve the SSH server configuration for all SVMs
Manage SSH security configuration
Security SSH svms svm.uuid endpoint overview
Retrieve the SSH server configuration for an SVM
Update the SSH server configuration for an SVM
Manage WebAuthn credentials
Security webauthn credentials endpoint overview
Retrieve all WebAuthn credentials entries
Delete a WebAuthn credentials entry
Retrieve a WebAuthn credentials entry
View WebAuthn global settings for a cluster and all SVMs
Security webauthn global-settings endpoint overview
Retrieve WebAuthn global settings for a cluster and all SVMs
View a WebAuthn global setting entry
Security webauthn global-settings owner.uuid endpoint overview
Retrieve a WebAuthn global setting entry
View all WebAuthn supported algorithms
Security webauthn supported-algorithms endpoint overview
Retrieve all WebAuthn supported algorithms entries
View a WebAuthn supported algorithms entry
Security webauthn supported-algorithms owner.uuid algorithm.name endpoint overview
Retrieve a WebAuthn supported algorithms entry
SnapLock
SnapLock overview
Manage SnapLock audit logs
Storage SnapLock audit-logs endpoint overview
Retrieve SVMs configured with audit log volumes
Create a SnapLock log configuration for an SVM
Disassociate SnapLock audit logs
Retrieve SnapLock audit logs
Update SnapLock audit logs
Manage the SnapLock ComplianceClock
Storage SnapLock compliance-clocks endpoint overview
Retrieve the SnapLock ComplianceClock for nodes in a cluster
Initialize a SnapLock ComplianceClock
Retrieve a SnapLock ComplianceClock for a node
Manage event based retention operations
Storage SnapLock event-retention operations endpoint overview
Retrieve EBR operations
Create an EBR policy
Cancel an ongoing EBR operation
Retrieve attributes for an EBR operation
Manage event based retention policies
Storage SnapLock event-retention policies endpoint overview
Retrieve event retention policies for an SVM
Create an EBR policy for an SVM
Delete an EBR policy
Retrieve attributes of an EBR policy
Update the retention period of an EBR policy
View key information about files and volumes
Storage SnapLock file-fingerprints endpoint overview
Retrieve fingerprint operations of an SVM and volume
Create a fingerprint computation session
Cancel a fingerprint operation
Retrieve the file fingerprint information for a specific session ID
Manage SnapLock file retention time
Storage SnapLock file volume.uuid path endpoint overview
Delete unexpired WORM files of a SnapLock enterprise volume
Retrieve SnapLock retention details of a file
Update the SnapLock retention time of a file
Manage SnapLock storage litigations
Storage SnapLock litigations endpoint overview
Retrieve litigations under an SVM
Start a legal-hold operation
Create a legal-hold end on all of the files for a litigation ID
Retrieve ongoing operations for a litigation ID
View litigation ID files
Storage SnapLock litigations litigation.id files endpoint overview
Display files for a litigation ID
Manage legal-hold operations
Storage SnapLock litigations litigation.id operations endpoint overview
Create or remove litigations for a path
Cancel the ongoing legal-hold operation
Retrieve the status of legal-hold for an operation ID
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
Manage storage aggregates
Storage aggregates UUID endpoint overview
Delete an aggregate specified by the UUID
Retrieve an aggregate specified by the UUID
Update an aggregate specified by the UUID
Manage storage aggregate metrics
Storage aggregates UUID metrics endpoint overview
Retrieve historical performance metrics for an aggregate
Manage storage bridges
Storage bridges endpoint overview
Retrieve a collection of bridges
Retrieve a specific bridge
Manage cluster-wide storage
Storage cluster endpoint overview
Report cluster-wide storage details across different tiers
Restore source directory
Storage directory-restore endpoint overview
Restore the source directory from the volume snapshot on the destination directory
Manage disks
Storage disks endpoint overview
Retrieve a collection of disks
Update disk ownership, change authentication keys, or sanitize disks
Retrieve a specific disk
Manage storage file clones
Storage file clone endpoint overview
Create a clone of the file
Retrieve the clone split load of a node
Retrieve the volume file clone split load
Update the maximum split load
Retrieve file clone split status of all volumes in the node
Retrieve file clone split status of all volumes
Retrieve information for a token
Create a new token to reserve the split load
Delete a specific file clone token
Retrieve a file clone token
Update a file clone token
Start a file copy operation
Manage storage file moves
Storage file moves endpoint overview
Retrieve all ongoing file move operations in the cluster
Start a file move operation
Check the status of an active file move operation
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
Pre-populate a FlexCache volume in the cluster
Manage storage FlexCache origin volumes
Storage flexcache origins endpoint overview
Retrieve the origin of a FlexCache in the cluster
Retrieve attributes of the origin of a FlexCache volume in the cluster
Modify origin options for a Flexcache origin volume in the cluster
Manage storage pools
Storage pools endpoint overview
Retrieve storage pools for the entire cluster
Create a new storage pool
Manage specific storage pools
Storage pools UUID endpoint overview
Delete a storage pool specified by the UUID
Retrieve a storage pool specified by the UUID
Update a storage pool specified by the UUID
Manage storage ports
Storage ports endpoint overview
Retrieve storage ports
Retrieve a storage port
Update 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 QoS options
Storage Qos qos-options endpoint overview
Retrieve QoS options
Update a QoS option
Manage QoS workloads
Storage Qos workloads endpoint overview
Retrieve QoS workloads
Retrieve a QoS workload
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
Retrieve historical performance metrics for a qtree with extended performance monitoring enabled
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
Update a shelf location LED
Manage snapshot policies
Storage snapshot-policies endpoint overview
Retrieve snapshot policies
Create a snapshot policy
Delete a snapshot policy
Retrieve snapshot policy details
Update a snapshot policy
Manage snapshot policies and schedules
Storage snapshot-policies snapshot_policy.uuid schedules endpoint overview
Retrieve snapshot policy schedules
Add a schedule to a snapshot policy
Delete a schedule from a snapshot policy
Retrieve snapshot policy schedule details
Update a snapshot policy schedule
Manage storage switches
Storage switches endpoint overview
Retrieve storage switches
Retrieve a specific storage switch
Manage storage tape devices
Storage tape-devices endpoint overview
Retrieve tape devices
Retrieve a tape device
Update a tape device
Manage volume efficiency policies
Storage volume-efficiency-policies endpoint overview
Retrieve volume efficiency policies
Create a volume efficiency policy
Delete a volume efficiency policy
Retrieve volume efficiency policy details
Update a volume efficiency 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
Manage files and directories
Storage volumes volume.uuid files path endpoint overview
Delete an existing file or directory
Retrieve files and directories
Write to an existing file with the supplied data
Create a new file with the supplied data
Retrieve historical performance metrics for a volume
Manage volume snapshots
Storage volumes volume.uuid snapshots endpoint overview
Retrieve volume snapshots
Create a volume snapshot
Delete a volume snapshot
Retrieve volume snapshot details
Update a volume snapshot
Retrieve clients
Storage volumes volume.uuid top-metrics clients endpoint overview
Retrieve clients with the most I/O activity
Retrieve directories
Storage volumes volume.uuid top-metrics directories endpoint overview
Retrieve directories with the greatest value performance metric or capacity metric
Retrieve files
Storage volumes volume.uuid top-metrics files endpoint overview
Retrieve files with the most I/O activity
Retrieve users
Storage volumes volume.uuid top-metrics users endpoint overview
Retrieve users with the most I/O activity
Support
Support overview
Manage an automatic update feature
Support auto-update endpoint overview
Retrieve the current status of an automatic update feature
Update the current enabled status of an automatic update feature
Retrieve automatic update configuration
Support auto-update configurations endpoint overview
Retrieve the configuration for an automatic update
Manage automatic update configuration
Support auto-update configurations UUID endpoint overview
Retrieve a specific configuration for an automatic update
Modify the configuration for an automatic update
Retrieve status for all automatic updates
Support auto-update updates endpoint overview
Retrieve status of all automatic updates
Manage automatic updates
Support auto-update updates UUID endpoint overview
Retrieve the status of an update
Perform an action on the update
Manage AutoSupport configuration
Support AutoSupport endpoint overview
Retrieve the AutoSupport configuration
Update the AutoSupport configuration for an entire cluster
Manage AutoSupport messages
Support AutoSupport messages endpoint overview
Retrieve AutoSupport message history
Create and send an AutoSupport message
Retrieve information about an AutoSupport message
Manage cluster configuration backup information
Support configuration-backup endpoint overview
Retrieve cluster configuration backup information
Update cluster configuration backup information
Manage configuration backups
Support configuration-backup backups endpoint overview
Retrieve configuration backup files
Create a configuration backup
Delete a configuration backup
Retrieve configuration backup file details
Manage core dumps
Support coredump coredumps endpoint overview
Retrieve core dumps
Delete a core dump
Retrieve a core dump
Manage EMS configuration
Support EMS endpoint overview
Retrieve an EMS configuration
Update an EMS configuration
Manage application logs
Support EMS application-logs endpoint overview
Create an application log
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
View and create EMS role-based configurations
Support EMS role-configs endpoint overview
Retrieve EMS role-based configurations
Create an EMS role-based configuration for an access control role
Manage EMS role-based configurations
Support EMS role-configs access_control_role.name endpoint overview
Remove the EMS role-based configuration for an access control role
Retrieve the EMS role-based configuration for an access control role
Update the EMS role-based configuration for an access control role
Manage cluster-wide SNMP configuration
Support SNMP endpoint overview
Retrieve the cluster-wide SNMP configuration
Update the cluster-wide SNMP configuration
Create or retrieve SNMP traphosts
Support SNMP traphosts endpoint overview
Retrieve SNMP traphosts
Create SNMP traphosts
Manage individual SNMP traphosts
Support SNMP traphosts host endpoint overview
Delete an SNMP traphost
Retrieve SNMP traphost details
Retrieve and create SNMP users
Support SNMP users endpoint overview
Retrieve SNMP users on a cluster
Create a cluster-scoped or an SVM-scoped SNMP user
Manage individual SNMP users
Support SNMP users engine_id name endpoint overview
Delete an SNMP user
Retrieve SNMP user details
Update the comment parameter of an SNMP user
Legal notices