Skip to main content

Docs
All NetApp

All docs
ONTAP

ONTAP 9.13.1 REST API reference

Version 9.13.1

9.13.1
9.15.1
9.14.1
9.12.1
9.11.1
9.10.1
9.9.1
9.8
9.7
9.6

ONTAP 9.13.1 REST API docs
REST API reference
Legal notices

A newer release of this product is available.

Protocols file-security effective-permissions svm.uuid path endpoint overview

08/29/2024 Contributors

Suggest changes

Request doc changes
Learn how to contribute

PDF of this doc site
- REST API reference
  - Application
    - Manage application Snapshot copies
    - Manage application consistency groups
    - Retrieve metrics of a consistency group
    - Manage application consistency group Snapshot copies
  - Cloud
    - Manage cloud targets
  - Cluster
    - 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
    - Manage environment sensors
    - Manage cluster software
    - View and update cluster web configurations
    - Retrieve resource tags
    - Manage resource tags
  - NAS
    - Manage Active Directory accounts
    - Manage Active Directory accounts for an SVM
    - Manage Active Directory domain controllers
    - 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
    - View group policy objects
    - Manage home directory search paths
    - Manage local groups
    - Manage local group members
    - 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
    - Perform bulk import for CIFS user groups
    - Manage CIFS user group privileges
    - View file security permissions
    - Manage file security permissions and audit policies
    - Manage FPolicy configuration
    - View and update FPolicy server configuration
    - Manage FPolicy engine configuration
    - Manage FPolicy event configuration
    - 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
    - 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-Access policie
    - Manage Vscan On-Demand policies
    - Manage Vscan scanner-pool configuration
  - NDMP
    - Manage NDMP mode
    - Manage NDMP node configurations
    - Manage NDMP session configurations
    - Manage NDMP configuration of SVM
    - Generate NDMP user password
  - NVMe
    - View NVMe interfaces
    - Manage NVMe services
    - View NVMe subsystem controllers
    - Manage NVMe subsystem maps
    - Manage NVMe subsystems
    - Manage NVMe namespaces
  - Name-services
    - 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
    - Manage UNIX group configurations
    - Manage UNIX group users
    - Manage UNIX user configurations
  - Networking
    - 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
    - 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
    - Manage S3 service policies
    - Manage S3 service users
  - SAN
    - Retrieve FC port information
    - Manage FC WWPN aliases
    - Manage FC services for SVMs
    - Manage SAN igroups
    - 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
    - Manage 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
    - 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
    - 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
    - Manage Azure Key Vaults
    - Manage security certificates
    - Manage 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
    - 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
    - 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
    - Manage SnapMirror policies
    - Manage SnapMirror relationships
    - Manage SnapMirror relationship tranfers
  - Storage
    - Retrieve or create a collection of storage aggregates
    - Manage storage aggregate plexes
    - Manage storage aggregates
    - Storage aggregate metrics
    - Manage bridges
    - Manage disks
    - Manage storage file clones
    - 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
    - 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
    - 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

Collection of separate PDF docs

Creating your file...

This may take a few minutes. Thanks for your patience.

Your file is ready