A newer release of this product is available.
Search results
9.8
- ONTAP 9.8 REST API docs
-
REST API reference
- Getting started with the ONTAP REST API
-
Application
- Application overview
- Retrieve applications
- Create an application
- Retrieve application components
- Retrieve application component Snapshot copies
- Create an application component Snapshot copy
- Delete an application component Snapshot copy
- Retrieve a Snapshot copy for a specific application component
- Restore an application component Snapshot copy
- Retrieve an application component
-
Manage application Snapshot copies
- Delete an application and all associated data
- Retrieve an application
- Update application properties
- Retrieve application templates
- Retrieve an application template
-
Cloud
-
Cluster
- Cluster overview
-
Manage clusters
-
Retrieve cluster chassis
-
View and manage cluster jobs
-
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
-
Manage cluster nodes
-
Cluster NTP
-
Manage cluster NTP keys
-
Manage cluster NTP servers
-
Manage cluster peers
-
Manage cluster schedules
-
Manage cluster software
- Cluster software endpoint overview
- Retrieve the cluster software profile
- Update the cluster software version
- Retrieve the software or firmware download status
- 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
- Upload a software or firmware package located on the local file system
-
Manage
-
Private manage event-remediations
- Event remediation and management action ### learn more * [`doc /private/manage/event-remediations`](#docs-manage-private_manage_event-remediations)
- Perform an event management action ### learn more * [`doc /private/manage/event-remediations`](#docs-manage-private_manage_event-remediations)
-
-
NAS
- NAS overview
-
Private protocols audit audit-log-redirect
- Private protocols audit audit-log-redirect endpoint overview
- Deletes an audit log redirect configuration ### related ontap commands * `vserver audit audit-log-redirect delete` ### learn more * [`doc /private/protocols/audit/audit-log-redirect`](#docs-nas-private_protocols_audit_audit-log-redirect)
- Retrieves audit log redirect configuration ### related ontap commands * `vserver audit audit-log-redirect show` ### learn more * [`doc /private/protocols/audit/audit-log-redirect`](#docs-nas-private_protocols_audit_audit-log-redirect)
- Updates an audit log redirect configuration ### required properties * `svmuuid` or `svmname` - existing svm to which nas audit events logs will be redirected to ### related ontap commands * `vserver audit audit-log-redirect modify` ### learn more * [`doc /private/protocols/audit/audit-log-redirect`](#docs-nas-private_protocols_audit_audit-log-redirect)
- Creates an audit log redirect configuration ### required properties * `svmuuid` or `svmname` - existing svm to which nas audit events logs will be redirected to ### related ontap commands * `vserver audit audit-log-redirect create` ### learn more * [`doc /private/protocols/audit/audit-log-redirect`](#docs-nas-private_protocols_audit_audit-log-redirect)
-
Manage NAS audit configurations
-
Manage home directory search paths
-
Manage CIFS services
-
View CIFS active sessions
-
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 the UNIX symbolic link mapping for CIFS clients
- Retrieve the UNIX symbolic link mapping for CIFS clients
- Update the UNIX symbolic link mapping for CIFS clients
- Retrieve trace results for denied or allowed events
- Delete trace results
- Retrieve trace results
- Retrieve security trace filter entry information
- Create security trace filter entries
- Delete security trace filters
- Retrieve security trace filter entry information
- Update security trace filter entries
-
View file security permissions
-
Manage FPolicy configuration
-
Manage FPolicy engine configuration
- Protocols fpolicy svm.uuid engines endpoint overview
- Retrieve the FPolicy engine configuration for all engines of an SVM
- Create an 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 SVM FPolicy configuration
-
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
-
Manage Vscan On-Demand policies
-
Manage Vscan scanner-pool configuration
- Protocols Vscan svm.uuid scanner-pools endpoint overview
- Retrieve the Vscan scanner-pool configuration for an SVM
- Create a 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
-
NVMe
-
Name-services
- Name-services overview
-
Manage DNS configurations
-
Manage LDAP server configurations
-
Manage name mappings for SVMs
-
Manage NIS server configurations
- Name-services NIS endpoint overview
- Retrieve NIS domain configurations of all SVMs
- Create the NIS domain and server configuration for a data SVM
- Delete the NIS domain configuration for an SVM
- Retrieve the NIS domain and server configurations for an SVM
- Update the NIS domain and server configuration for an SVM
-
Networking
- Networking overview
-
Manage broadcast domains
-
Manage network Ethernet ports
-
Retrieve network Ethernet switch ports
-
Manage Ethernet switches
-
Manage FC network interfaces
-
Retrieve FC port information
-
Manage HTTP proxy configuration
- Deletes the http proxy configuration of the specified svm or cluster ipspace ### related ontap commands * `vserver http-proxy delete`
- Displays the http proxy server, port, and ipspace of the specified svm or cluster ipspace ### related ontap commands * `vserver http-proxy show`
- Updates the proxy server, port, username, and password parameters important notes: * ipv6 must be enabled if ipv6 family addresses are specified in the "server" field * the server and the port combination specified using the "server" and "port" fields is validated during this operation the validation will fail in the following scenarios: * the http proxy service is not configured on the server * the http proxy service is not running on the specified port * the server is unreachable ### related ontap commands * `vserver http-proxy modify`
-
Manage BGP peer groups
-
Manage network IP interfaces
-
Manage network IP routes
-
Manage network IP service policies
-
Manage network IPspaces
-
Object-store
-
Manage S3 buckets
-
Manage protocols S3 services
-
Manage S3 service bucket configuration
-
Manage S3 service group configuration
- Protocols S3 services svm.uuid groups endpoint overview
- Retrieve an S3 group configuration
- Create an S3 group configuration
- Delete the S3 group configuration for an SVM
- Retrieve the S3 group configuration for an SVM
- Update 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 initiators of an initiator group
- Add initiators to an initiator group
- Delete an initiator from an initiator group
- Retrieve an initiator
- Delete an initiator group
- Retrieve an initiator group
- Update an initiator group
-
Manage iSCSI credentials
-
Manage iSCSI services
-
View iSCSI sessions
-
Manage SAN LUN maps
-
Manage LUNs
-
SVM
-
Security
- Security overview
-
Manage security-related operations
-
Manage security-related accounts
-
Manage scoped user accounts
-
View and update audit settings
-
Forward audit logs to syslog/splunk servers
- Security audit destinations endpoint overview
- Define a remote syslog or splunk server to receive audit information
- Define remote syslog or splunk server information
- Delete remote syslog or splunk server information
- Retrieve remote syslog or splunk server information
- Update 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 Azure Key Vaults
-
Manage security certificates
-
View and update IPsec configuration
-
Manage IPsec policies
-
View IPsec security associations
-
Manage key managers
- 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
-
View and update login message configuration
-
Manage security roles
-
View or delete a role
-
Manage role privilege details
-
Manage role privilege path
-
Manage SSH server
-
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
- Report cluster-wide storage details across different tiers
-
Manage disks
-
Manage storage file clones
- Start a file move operation
-
Manage FlexCache volumes
-
Manage storage FlexCache origin volumes
-
View and create monitored files
- Retrieves historical performance metrics for the monitored file
-
Manage storage ports
-
Manage QoS policies
-
Manage storage qtrees
-
Storage quota
-
Manage storage quota reports
-
Manage storage quota policy rules
-
Manage shelves
-
Manage Snapshot copy policies
-
Manage Snapshot copy policies and schedules
- Create a volume efficiency policy
- Delete a volume efficiency policy
-
Manage storage volumes
-
Manage files and directories
-
Manage volume Snapshot copies
-
Support
- Support overview
-
Manage AutoSupport configuration
-
Manage AutoSupport messages
-
Manage cluster configuration backup information
-
Manage configuration backups
-
Manage EMS configuration
-
Manage event destinations
-
Manage an event destination instance
-
Retrieve events
-
Create or retrieve event filters
-
Manage event filters
-
Create or retrieve filter rules
-
Manage event filter rules
-
Manage EMS event catalog
-
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