A newer release of this product is available.
Search results
9.13.1
- ONTAP 9.13.1 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
-
Manage application consistency groups
-
Retrieve metrics of a consistency group
-
Manage application consistency group Snapshot copies
- Application consistency-groups consistency_group.uuid snapshots endpoint overview
- Retrieve consistency group Snapshot copies
- Create a consistency group Snapshot copy
- Delete a consistency group Snapshot copy
- Retrieve a consistency group Snapshot copy
- Complete a consistency group Snapshot copy operation
- Retrieve application templates
- Retrieve an application template
-
Cloud
-
Cluster
- Cluster overview
-
Manage clusters
-
Retrieve cluster chassis
-
Retrieve cluster counter tables
-
Manage cluster firmware history
-
View and manage cluster jobs
-
Retrieve capacity pool licenses
-
Manage cluster license managers
-
Manage cluster licensing
-
Manage cluster mediators
-
View and manage MetroCluster configurations
-
Display MetroCluster diagnostics
-
Manage MetroCluster DR groups
-
View and update MetroCluster interconnects
-
Retrieve MetroCluster node configurations
-
Retrieve MetroCluster operations
-
Retrieve MetroCluster SVMs
-
Manage cluster nodes
-
Cluster NTP
-
Manage cluster NTP keys
-
Manage cluster NTP servers
-
Manage cluster peers
-
Manage cluster schedules
- Retrieve environment sensors
-
Manage environment sensors
-
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 software package information
- Upload a software or firmware package located on the local file system
-
View and update cluster web configurations
-
Retrieve resource tags
-
Manage resource tags
-
NAS
- NAS overview
-
Manage Active Directory accounts
-
Manage Active Directory accounts 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
-
Manage S3 audit configurations
-
View CIFS connection information
-
View CIFS domain-related information
-
View and update CIFS domain-related information (specific 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
-
Manage home directory search paths
-
Manage local groups
-
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
-
View NetBIOS information
-
Manage CIFS services
-
View CIFS active file sessions
-
View CIFS active sessions
-
View and update shadow copy information
-
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 UNIX symbolic link mapping for CIFS clients
- Retrieve a UNIX symbolic link mapping for CIFS clients
- Update UNIX symbolic link mapping for CIFS clients
-
Perform bulk import for CIFS user groups
-
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
-
Manage file security permissions and audit policies
-
Manage FPolicy configuration
-
View and update FPolicy server 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 the 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 specific FPolicy event configuration for an SVM
- Retrieve specific FPolicy event configuration for an SVM
- Update specific FPolicy event configuration for an SVM
-
Manage SVM FPolicy configuration
-
View lock details
-
View NFS client information
-
View and update NFS client settings
-
View NFS connected clients
-
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
- 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 policies configuration for an SVM
-
Manage Vscan On-Access policie
- Create a Vscan On-Demand policy
-
Manage Vscan On-Demand policies
-
Manage Vscan scanner-pool configuration
- Protocols Vscan svm.uuid scanner-pools endpoint overview
- Retrieve a Vscan scanner-pool configuration for an SVM
- Create a Vscan scanner-pool configuration for an SVM
- Delete a Vscan scanner-pool configuration
- Retrieve a Vscan scanner-pool configuration for an SVM
- Update a Vscan scanner-pool configuration for an SVM
-
NDMP
-
NVMe
-
Name-services
- Name-services overview
-
Manage group membership cache settings
-
Manage host cache settings
-
Manage netgroup cache settings
-
Manage global cache settings
-
Manage UNIX group cache settings
-
Manage UNIX user cache settings
-
Manage DNS configurations
-
View host records
-
Manage LDAP server configurations
-
Manage LDAP schemas
-
Manage local mapping for hostnames
-
Manage name mappings for SVMs
-
Display netgroup file details
-
Manage NIS server configurations
- Name-services NIS endpoint overview
- Retrieve the 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 NIS domain and server configurations for an SVM
- Update NIS domain and server configuration for an SVM
-
Manage UNIX group configurations
-
Manage UNIX group users
-
Manage UNIX user configurations
-
Networking
- Networking overview
-
Manage broadcast domains
-
Manage network ethernet ports
-
Retrieve network Ethernet switch ports
-
Manage Ethernet switches
-
Retrieve FC fabrics
-
Manage FC network interfaces
-
Retrieve FC port information
-
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
-
Manage network IP interfaces
-
Manage network IP routes
-
Manage network IP service policies
-
Manage network IP subnets
-
Manage network IPspaces
-
Object-store
-
Manage S3 buckets
-
Manage protocols S3 services
-
Manage S3 service bucket configuration
-
Manage S3 bucket lifecycle management rules
-
Manage S3 service group configuration
- Protocols S3 services svm.uuid groups endpoint overview
- Retrieve the S3 group configuration
- Create an S3 group configuration
- Delete an S3 group configuration for an SVM
- Retrieve the S3 group configuration for an SVM
- Update the S3 group configuration for an SVM
- Retrieve S3 protocol historical performance metrics
-
Manage S3 service policies
-
Manage S3 service users
-
-
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 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 iSCSI credentials
-
Manage iSCSI services
-
View iSCSI sessions
-
Manage SAN LUN maps
-
Add, remove, or discover LUN map reporting nodes
-
Manage SAN portsets
-
Manage SAN vVol bindings
-
Manage LUNs
-
Manage LUN attributes
-
SVM
- SVM overview
-
Manage SVM migration
- SVM migrations endpoint overview
- Retrieve 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
-
Manage SVM peer relationships
-
Manage SVMs
-
Retrieve clients
-
Retrieve directories
-
Retrieve files
-
Retrieve users
-
Manage web services security configuration
-
Security
- Security overview
-
Manage security-related operations
-
Manage security-related accounts
-
Manage scoped user accounts
-
View suspect files generated by anti-ransomware
-
Delete suspect files
-
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 data SVM account information
-
Manage LDAP server configuration
-
Manage NIS configuration
-
Manage SAML service
-
Update user account password
-
Manage authentication keys (for admins)
-
Manage authentication keys (end-users)
-
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
-
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
-
View and update IPsec configuration
-
Manage IPsec security certificates
-
Manage IPsec policies
-
View IPsec security associations
-
View and update key manager configurations
-
Manage key managers
-
Manage authentication keys
-
View security key managers
- Migrate SVM keys between security key managers
- 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 key stores
-
View and update login message configuration
-
Manage TOTP profiles
-
Manage TOTP profile for a specific user account
-
Manage the multi-admin-verify global setting
-
Manage multi-admin approval groups
-
Manage multi-admin-verify approval groups
-
Manage multi-admin-verify approval requests
-
Manage a multi-admin-verify approval request
-
Manage multi-admin-verify rules
-
Manage a multi-admin-verify rule
-
Manage security roles
-
View or delete a role
-
Manage role privilege details
-
Manage role privilege path
-
Manage SSH server
-
View SSH SVMs
-
Manage SSH security configuration
-
SnapLock
- SnapLock overview
-
Manage SnapLock audit logs
-
Manage the SnapLock ComplianceClock
-
Manage event based retention operations
-
Manage event based retention policies
-
View key information about files and volumes
-
Manage SnapLock file retention time
-
Manage SnapLock storage litigations
-
View litigation ID files
-
Manage legal-hold operations
-
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
-
Manage storage aggregates
-
Storage aggregate metrics
-
Manage bridges
-
Manage disks
-
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
-
Manage FlexCache volumes
-
Manage storage FlexCache origin volumes
-
Manage storage pools
-
Manage specific storage pools
-
Manage storage ports
-
Manage QoS policies
-
Manage QoS workloads
-
Manage storage qtrees
-
Storage quota
-
Manage storage quota reports
-
Manage storage quota policy rules
-
Manage shelves
-
Create and retrieve Snapshot copy policies
-
Manage Snapshot copy policies and schedules
- Storage snapshot-policies snapshot_policy.uuid schedules endpoint overview
- Retrieve Snapshot copy policy schedules
- Add a schedule to a Snapshot copy policy
- Delete a schedule from a Snapshot copy policy
- Retrieve Snapshot copy policy schedule details
- Update a Snapshot copy policy schedule
- Delete a Snapshot copy policy
- Retrieve Snapshot copy policy details
- Update a Snapshot copy policy
-
Manage storage switches
-
Manage storage tape devices
-
Manage volume efficiency policies
-
Manage storage volumes
-
Manage files and directories
-
Manage volume Snapshot copies
-
Retrieve clients
-
Retrieve directories
-
Retrieve files
-
Retrieve users
-
Support
- Support overview
-
Manage an automatic update feature
-
Retrieve automatic update configuration
-
Manage automatic update configuration
-
Retrieve status for all automatic updates
-
Manage automatic updates
-
Manage AutoSupport configuration
-
Manage AutoSupport messages
-
Manage cluster configuration backup information
-
Manage configuration backups
-
Manage core dumps
-
Manage EMS configuration
-
Manage application logs
-
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
-
View and create EMS role configurations
-
Manage EMS role configurations
-
Manage cluster-wide SNMP configuration
-
Create or retrieve SNMP traphosts
-
Manage individual SNMP traphosts
-
Retrieve and create SNMP users
-
Manage individual SNMP users
- Legal notices