NetApp Console API docs
Get started
NetApp Console control plane
Common REST implementation
Basic concepts
HTTP details
Additional considerations
Use the API Explorer
Workflow processes and tasks
Authentication and authorization
Basic concepts
User access tokens
Grant types
Console agent and client identifiers
Use the REST APIs
NetApp Console common workflows and tasks
Get required identifiers
Create user token
Register service
Create service token
Generate NSS user ID
ONTAP management
Get started
Overview
Prepare
Your first API call
Workflow processes
Cloud Volumes ONTAP workflows
Before you begin
Typical deployment
AWS workflows
Systems
Create a system with a capacity-based license
Create a system with PAYGO (node-based)
Create a system with BYOL (node-based)
Get systems
Delete a system
Create a CIFS server configuration
Get CIFS configurations
Delete a CIFS server configuration
Aggregates
Add a capacity to an EV aggregate
Get aggregates
Create an aggregate
Add disks to an aggregate
Delete an aggregate
Volumes
Create a volume using NFS
Create a volume using CIFS
Create a volume using iSCSI
Get volumes
Modify a volume
Delete a volume
Create a quote
Get iGroups
Metadata
Get regions
Get permutations
Get virtual private clouds
Get EBS volume types
Get packages
Get route tables
Get key pairs
Miscellaneous
Create an AWS cloud provider account
Azure workflows
Systems
Create a system with a capacity-based license
Create a system with PAYGO (node-based)
Create a system with BYOL (node-based)
Get systems
Delete a system
Create a CIFS server configuration
Get CIFS configurations
Delete a CIFS server configuration
Aggregates
Get aggregates
Create an aggregate
Add disks to an aggregate
Delete an aggregate
Volumes
Create a volume using NFS
Create a volume using CIFS
Create a volume using iSCSI
Get volumes
Modify a volume
Delete a volume
Create a quote
Get iGroups
Metadata
Get Azure regions
Get Azure permutations
Get Azure storage account types
Get Azure VNets
Get Azure availability zones
Get Azure packages
Miscellaneous
Create an Azure cloud provider account
Google Cloud workflows
Systems
Create a system with a capacity-based license
Create a system with PAYGO (node-based)
Create a system with BYOL (node-based)
Get systems
Delete a system
Create a CIFS server configuration
Get CIFS server configurations
Delete a CIFS server configuration
Aggregates
Get aggregates
Create an aggregate
Add disks to an aggregate
Delete an aggregate
Volumes
Create a volume using NFS
Create a volume using CIFS
Create a volume using iSCSI
Get volumes
Modify a volume
Delete a volume
Create a quote
Get iGroups
Metadata
Get Google Cloud regions
Get permutations
Get tag keys
Create buckets
Get buckets
Get Google Cloud packages
Get snapshot policies
Get supported features
Get supported capacity tiers
Get service accounts
Get projects
Get Google Cloud encryption keys
Get disk types
Get instance types
Get VPCs
Get zones
On-premises ONTAP cluster workflows
Before you begin
Systems
Get systems
Discover systems
Volumes
Create a volume using NFS
Create a volume using CIFS
Create a volume using iSCSI
Create a FlexGroup volume
Get volumes
Modify a volume
Delete a volume
Aggregates
Get aggregates
ONTAP management common workflows
Before you begin
Identity and access
Get supported services
Get cloud provider accounts
Get tenants
SaaS marketplace
Get SaaS marketplace account
Attach a subscription
NetApp Support Site
Create an NSS ID
Get an NSS ID
Get an NSS IDs
Delete an NSS ID
Internal tasks and support
Get an active task
SnapMirror replication
Create a relationship
Update a relationship
Delete a relationship
Get relationships
Get the relationships status
Get relationship status for a system
Get intercluster LIFs
Get schedules for a system
Get SnapMirror policies
Get SnapMirror SVM policies
ONTAP management API reference
AWS aggregates (HA)
Add capacity to an elastic volume aggregate
Delete an aggregate
Retrieve aggregates
Create a new aggregate
Add disks to an existing aggregate
AWS aggregates (single-node)
Add the capacity to an existing elastic volume aggregate
Delete an existing aggregate
Retrieve aggregates
Create a new aggregate
Add disks to an existing aggregate
AWS system discovery (HA)
Retrieve a list of discovered systems
Save a previously discovered system
AWS system discovery (single-node)
Retrieve a list of discovered systems
Save a previously discovered Cloud Volumes ONTAP system
AWS system encryption (HA)
Add a key manager to a system
Delete a key manager from a system
Update the key manager CA certificate on a system
Update client certificate on a system
AWS system encryption (single-node)
Add a key manager
Delete a key manager
Update the key manager CA certificate
Update the client certificate
AWS system metadata (HA)
Validate HA floating IP addresses
Retrieve route tables per VPC and their subnet associations
Retrieve all system configurations
Retrieve the minimum number of required IP addresses
Retrieve AWS encryption keys by region
Confirm the current user subscription
Retrieve all S3 buckets with additional information
Retrieve the S3 buckets policy status and tiering level
Retrieve VPCs
Retrieve S3 buckets summary
Retrieve AWS user key pairs by region
Retrieve AWS user key pairs for all regions
Retrieve AWS instance profiles
Retrieve all NetApp Console manifests
Retrieve all S3 buckets
Retrieve supported capacity tiers for EBS volume types
Create a new S3 bucket
Retrieve supported EBS volume types
Retrieve all tag names
Retrieve AWS regions
Retrieve default snapshot policies available on a cluster
Retrieve unsupported instance types for acceleration and capacity tiering
Retrieve supported features
Retrieve packages configuration
AWS system metadata (single-node)
Retrieve all Cloud Volumes ONTAP configurations
Retrieve the minimum number of required IP addresses
Retrieve AWS encryption keys by region
Comfirm that the current user is subscribed
Retrieve all S3 buckets
Retrieve S3 buckets policy status and tiering level
Retrieve VPCs
Retrieve S3 buckets summary
Retrieve AWS user key pairs by region
Retrieve AWS user key pairs for all regions
Retrieve AWS instance profiles
Retrieve all NetApp Console manifests
Retrieve all S3 buckets
Retrieve supported capacity tiers for EBS volume types
Create a new S3 bucket
Retrieve supported EBS volume types
Retrieve all tag names
Retrieve AWS regions
Retrieve default snapshot policies available on a cluster
Retrieve unsupported instance types for acceleration and capacity tiering
Retrieve supported features
Retrieve package configurations
AWS systems (HA)
Retrieve Cloud Volumes ONTAP systems
Create a new AWS HA Cloud Volumes ONTAP system
Update the route tables for an HA system
Update the mediator for a system
Check for non-persistent locks held on CIFS sessions
Retrieve an HA system
Delete an existing system
Retrieve the CIFS configuration for a system
Create a new CIFS configuration for a system
Delete the CIFS configuration for a system
Validate prerequisites for converting a system
Retrieve a list of upgrade versions
Set the writing speed for a system
Retrieve all license types and their associated instance types
Set the instance type
Retrieve images already installed on system
Perform a complete image update operation
Retrieve the eligibility support status of a system
Upload a cloud license file
Upload cloud license file content
Activate an off-box configuration
Modify the network port broadcast domain MTU
Retrieve action parameters
Enable capacity tiering
Retrieve the system cost and usage
Trigger subscription synchronization
Retrieve systems ONTAP savings
Retrieve extra capacity licenses
Update an extra capacity license
Register an extra capacity license
Update extra capacity license serial numbers
Register extra capacity license serial numbers
Delete extra capacity licenses using the serial number
Update the default Vscan file operation profile
Update the NetApp Console password
Update the tier level
Update a BYOL license to a capacity-based license
Enable SnapLock for a system
Set up an NTP server
Start a specific instance
Stop a specific instance
Retrieve the support registration status of a system
Register a system with NetApp
List the start/stop schedules for a system
Set the schedules for a system
Modify the SVM name of a system
Activate FPolicy for ransomware files
Disable FPolicy for ransomware files
Delete FPolicy for ransomware files
Retrieve editable tags for cloud resources
Modify user tags for cloud resources
Activate snapshot policy assignment for all unprotected read/write volumes
Create a snapshot policy
Update the serial number of a system
Parse an uploaded cloud license file
Set the cluster password for a system
AWS systems (single-node)
Retrieve a CIFS configuration for a system
Set up a new CIFS configuration
Delete the CIFS configuration for a system
Validate prerequisites for converting a system
Retrieve a Cloud Volumes ONTAP system
Delete an existing Cloud Volumes ONTAP system
Retrieve a list of upgrade versions
Set the writing speed for Cloud Volumes ONTAP
Retrieve all license types
Set the instance type
Retrieve images already installed on the system
Perform a complete image update
Retrieve the eligibility support status
Upload a cloud license file
Upload cloud license file content
Activate an off-box configuration
Modify the network port broadcast domain MTU
Retrieve the action parameters
Enable capacity tiering
Retrieve systems cost and usage
Trigger subscription synchronization
Retrieve systems ONTAP savings
Retrieve extra capacity licenses
Update extra capacity licenses
Register extra capacity licenses
Update extra capacity serial numbers
Register extra capacity serial numbers
Delete extra capacity licenses by serial numbers
Update the default Vscan file operation profile
Update the NetApp Console password
Modify the tier level
Update the BYOL licence to a capacity-based license
Enable SnapLock for an existing system
Set up an NTP server
Start a specific Cloud Volumes ONTAP instance
Stop a specific Cloud Volumes ONTAP instance
Retrieve the support registration status
Register a Cloud Volumes ONTAP system
List the start/stop schedules
Set the schedules
Modify the SVM name
Activate the FPolicy for ransomware files
Disable the FPolicy for ransomware files
Delete the FPolicy for ransomware files
Retrieve editable tags for cloud resources
Modify user tags for cloud resources
Activate snapshot policy assignments
Create a snapshot policy
Update the serial number of Cloud Volumes ONTAP
Parse an uploaded cloud license file
Set the cluster password
Retrieve Cloud Volumes ONTAP systems
Create a new Cloud Volumes ONTAP system
AWS volumes (HA)
Retrieve volumes for backup activation
Retrieve quotes for a new volume
Update the underlying volume tier
Modify an existing volume
Delete an existing volume
Add an export policy rule
Retrieve a list of snapshot descriptions for the volume
Retrieve all igroups
Retrieve all iSCSI initiators
Add an iSCSI initiator
Retrieve all volumes
Create a new volume
Clone an existing volume
Create a snapshot
Delete a snapshot
Move an existing volume
AWS volumes (single-node)
Retrieve the volumes for backup activation
Retrieve quotes for a new volume
Update the underlying volume tier
Modify an existing volume
Delete an existing volume
Add an export policy rule
Retrieve a list of snapshot descriptions for the volume
Retrieve all igroups
Retrieve all iSCSI initiators
Add an iSCSI initiator
Retrieve volumes
Create a new volume
Clone an existing volume
Create a snapshot
Delete a snapshot
Move an existing volume
Account operations
Create an Azure account
Create a Google Cloud storage account
Retrieve a Google Cloud storage account
Update a Google Cloud storage account
Update the VSA list of an NSS account
Retrieve all cloud accounts
Retrieve an AWS account ID for credentials
Validate the Google Cloud account request
Validate an Azure account request
Retrieve an AWS account
Update an existing AWS account
Create an AWS account
Retrieve an NSS account
Update an NSS account
Delete an existing account
Retrieve an Azure account
Update an Azure account
Create an NSS account
Retrieve accounts
Amazon FSx for NetApp ONTAP management systems
Retrieve CIFS configuration for an FSx system
Create a new CIFS configuration for an FSx system
Retrieve an export policies list for an FSx system
Validate the credentials for an FSx system
Retrieve an SVM list for an FSx system
Retrieve network interfaces lists for an FSx system
Retrieve snapshot policies for an FSx system
Amazon FSx for NetApp ONTAP management volumes
Retrieve volumes
Retrieve a volume using the ID
Retrieve an NFS clients list for an FSx system
Retrieve a CIFS share list for an FSx system
Retrieve the volume count
Modify an existing volume
Delete an existing volume
Retrieve a list of snapshot descriptions for a volume
Retrieve all igroups
Retrieve all iSCSI initiators
Add an iSCSI initiator
Create a new volume
Clone a volume
Create a snapshot
Delete a snapshot
Audit operations
Retrieve audit groups and group records
Retrieve an active task
Retrieve an audit group entry
Retrieve audit group entries
Retrieve an audit record
Retrieve audit page filter options
Retrieve audit group entries
Azure aggregates (HA)
Update IOPS and throughput for disks in an existing aggregate
Delete an aggregate
Retrieve aggregates
Create a new aggregate
Add disks to an aggregate
Azure aggregates (single-node)
Update IOPS and throughput for disks in an existing aggregate (single-node)
Delete an aggregate
Retrieve aggregates
Create a new aggregate
Add disks to an aggregate
Azure system discovery (HA)
Save a system to the NetApp Console database
Retrieve a list of systems for the Azure region
Azure system discovery (single-node)
Save a previously discovered Cloud Volumes ONTAP system
Retrieve a list of discovered systems
Azure system metadata (HA)
Retrieve all ONTAP cloud configurations
Retrieve the minimum number of IP addresses
Validate the Azure marketplace subscription
Retrieve subscriptions
Retrieve network extended information
Retrieve all vaults
Retrieve all keys in a vault
Retrieve Azure resource groups
Create a new blob container
Retrieve Azure availability zones
Retrieve all blob containers
Retrieve capacity tiers for Azure disk types
Retrieve Azure storage account types
Retrieve tag names
Retrieve Azure regions
Retrieve the default snapshot policies
Retrieve unsupported instance types for acceleration and capacity tiering
Retrieve supported features
Retrieve the packages configuration
Azure system metadata (single-node)
Retrieve the minimum number of required IP addresses
Confirm the current user subscription
Retrieve associated subscriptions
Retrieve network extended information
Retrieve all vaults
Retrieve all keys in a vault
Retrieve Azure resource groups by region
Create a new blob container
Retrieve Azure availability zones by region
Retrieve all blob containers
Retrieve supported capacity tiers for Azure disk types
Retrieve supported Azure storage account types
Retrieve all tag names
Retrieve all Cloud Volumes ONTAP configurations
Retrieve Azure regions
Retrieve the default snapshot policies
Retrieve unsupported instance types for acceleration and capacity tiering
Retrieve supported features
Retrieve package configurations
Azure systems (HA)
Retrieve HA systems
Create a new Azure HA system
Check for non-persistent locks
Delete an SVM
Modify the SVM name of the system
Create a new SVM
Retrieve Azure VMware Solution private cloud clusters for a subscription
Retrieve Azure VMware Solution cluster hosts for a subscription
Retrieve available IP addresses in the subnet of a system
Check if a resource group with the specified name exists
Retrieve an Azure VMware Solution private cloud for a subscription
Retrieve a system
Delete a system
Retrieve the CIFS configuration for a system
Create a new CIFS configuration for a system
Delete the CIFS configuration for a system
Validate prerequisites for converting a system
Retrieve a list of upgrade versions
Set the writing speed
Retrieve all license types and their associated instance types
Set the instance type
Retrieve images already installed on a system
Perform an image update on a single node
Retrieve the eligibility support status of a system
Upload a cloud license file
Upload cloud license file content
Activate the off-box configuration
Modify the network port broadcast domain MTU
Retrieve action parameters
Enable capacity tiering
Retrieve the system cost and usage
Trigger subscription synchronization
Retrieve system ONTAP savings
Retrieve extra capacity licenses
Update an extra capacity license
Register an extra capacity license
Update extra capacity serial numbers
Register extra capacity serial numbers
Delete extra capacity licenses by serial number
Update the default Vscan file operation profile
Update the NetApp Console password
Update the tier level
Update a BYOL license to a capacity-based license
Enable SnapLock for a system
Create an NTP server
Start a Cloud Volumes ONTAP instance
Stop a Cloud Volumes ONTAP instance
Retrieve the support registration status
Register a Cloud Volumes ONTAP system with NetApp
List the start/stop schedules for Cloud Volumes ONTAP
Set schedules for Cloud Volumes ONTAP
Activate FPolicy for ransomware files
Disable FPolicy for ransomware files
Delete FPolicy for ransomware files
Retrieve editable tags for the cloud resources
Modify the user tags for cloud resources
Activate snapshot policy assignment
Create a snapshot policy
Update the serial number of a system
Parse an uploaded cloud license file
Set the cluster password for a system
Azure systems (single-node)
Retrieve Cloud Volumes ONTAP systems
Create a new Cloud Volumes ONTAP system
Delete an SVM
Modify the SVM name
Create a new SVM
Retrieve Azure VMware Solution private cloud clusters
Retrieve Azure VMware Solution cluster hosts
Retrieve the number of available IP addresses
Check if a resource group with the specified name exists
Retrieve an Azure VMware Solution private cloud
Retrieve a Cloud Volumes ONTAP system
Delete an existing Cloud Volumes ONTAP system
Retrieve a CIFS configuration
Set up a new CIFS configuration
Delete a CIFS configuration
Validate prerequisites for converting a system
Retrieve a list of upgrade versions
Modify the writing speed
Retrieve all license types
Set the instance type
Retrieve images already installed
Perform a complete image update operation
Retrieve the eligibility support status
Upload a cloud license file
Upload cloud license file content
Activate an off-box configuration
Modify the network port broadcast domain MTU
Retrieve the action parameters
Enable capacity tiering
Retrieve systems cost and usage
Trigger subscription synchronization
Retrieve systems ONTAP savings
Retrieve extra capacity licenses
Update extra capacity licenses
Register extra capacity licenses
Update extra capacity serial numbers
Register extra capacity serial numbers
Delete extra capacity licenses by serial numbers
Update the default Vscan file operation profile
Update the NetApp Console password
Change the tier level
Update the BYOL licence to a capacity-based license
Enable SnapLock for an existing system
Set up an NTP server
Start a specific Cloud Volumes ONTAP instance
Stop a specific Cloud Volumes ONTAP instance
Retrieve the support registration status
Register a Cloud Volumes ONTAP system with NetApp
List the start-stop schedules
Set the schedules for Cloud Volumes ONTAP
Activate the FPolicy for ransomware files
Disable the FPolicy for ransomware files
Delete the FPolicy for ransomware files
Retrieve editable tags for cloud resources
Modify user tags for cloud resources
Activate snapshot policy assignment
Create a snapshot policy
Update the serial number of Cloud Volumes ONTAP
Parse an uploaded cloud license file
Set the cluster password for a Cloud Volumes ONTAP system
Azure volumes (HA)
Synchronize Azure VMware Solution hosts
Remove Azure VMware Solution hosts on a volume
Retrieve volumes for backup activation
Retrieve quotes for a new volume
Update the underlying volume tier
Modify an existing volume
Delete an existing volume
Add an export policy rule
Retrieve a list of volume snapshot descriptions
Retrieve all igroups
Retrieve all iSCSI initiators
Add an iSCSI initiator
Set up Azure VMware Solution on a volume
Retrieve volumes
Create a new volume
Clone an existing volume
Create a snapshot
Delete a snapshot
Move an existing volume
Azure volumes (single-node)
Retrieve volumes for backup activation
Retrieve quotes for a new Azure volume
Update the underlying volume tier
Modify an existing volume
Delete an existing volume
Add an export policy rule
Retrieve a list of volume snapshot descriptions
Retrieve all igroups
Retrieve all iSCSI initiators
Add an iSCSI initiator
Retrieve all volumes
Create a new volume
Clone an existing volume
Create a snapshot
Delete a snapshot
Move an existing volume
Cloud compliance operations
Retrieve the service cloud compliance status using the file system ID
Deploy a cloud compliance instance by systems
Retrieve cloud compliance information
Disable on-premises scanning
Retrieve the service cloud compliance status using the service ID
Enable scanning using the service ID
Disable scanning using the service ID
Enable on-premises scanning using the system ID
Enable scanning using the file system ID
Disable scanning using the file system ID
Enable scanning using the system ID
Disable scanning using the system ID
Common system operations
Check if a system with the specified name exists
Retrieve all non-premises system actions for a tenant ID
Retrieve all systems
Retrieve a Cloud Volumes ONTAP system
FlexCache volume operations
Create a new FlexCache volume for an FSx system
Modify a FlexCache volume
Delete a FlexCache volume
Retrieve all FlexCache volume relationships
Create a new FlexCache volume
Retrieve all FlexCache volumes lists
Google Cloud aggregates (HA)
Retrieve aggregates
Delete an aggregate
Create a new aggregate
Add disks to an aggregate
Google Cloud aggregates (single-node)
Retrieve aggregates
Delete an aggregate
Create a new aggregate
Add disks to an aggregate
Google Cloud system discovery (HA)
Retrieve a list of HA systems for a Google Cloud region
Save an HA system to the NetApp Console database
Google Cloud system discovery (single-node)
Retrieve a list of systems for a Google Cloud zone
Save a system to the NetApp Console database
Google Cloud system metadata (HA)
Retrieve Google Cloud networks and subnetworks
Retrieve Google Cloud regions and zones
Retrieve all labels for a project ID and region
Retrieve all Cloud Volumes ONTAP configurations
Retrieve the minimum number of IP addresses for a system
Retrieve Google Cloud encryption keys for a region
Retrieve all cloud storage buckets
Retrieve a list of service accounts
Retrieve supported capacity tiers for Google Cloud disk types
Create a new bucket
Retrieve the supported disk types
Retrieve a list of projects
Retrieve Google Cloud regions
Retrieve the default snapshot policies
Retrieve instance types that do not support acceleration and capacity tiering
Retrieve supported features
Retrieve the packages configuration
Google Cloud system metadata (single-node)
Retrieve the minimum number of IP addresses for a system
Retrieve Google Cloud encryption keys for a region
Retrieve all cloud storage buckets
Retrieve a list of service accounts
Retrieve supported capacity tiers for Google Cloud disk types
Create a new bucket
Retrieve the supported Google Cloud disk types
Retrieve all the labels for a project ID and zone
Retrieve a list of projects
Retrieve all Cloud Volumes ONTAP configurations
Retrieve Google Cloud regions
Retrieve default snapshot policies
Retrieve the instance types that do not support acceleration and capacity tiering
Retrieve supported features
Retrieve the packages configuration
Google Cloud systems (HA)
Retrieve Cloud Volumes ONTAP systems
Create a new Cloud Volumes ONTAP Google Cloud HA system
Stop a specific Cloud Volumes ONTAP instance
Check for non-persistent locks held on CIFS sessions
Delete an SVM
Retrieve a system
Delete an existing system
Modify the SVM name of the Cloud Volumes ONTAP system
Create a new SVM
Retrieve the CIFS configuration for a system
Create a new CIFS configuration for a system
Delete the CIFS configuration for a system
Validate prerequisites for converting a system
Retrieve a list of upgrade versions
Modify the writing speed for a system
Retrieve all license types for a system
Set the instance type
Retrieve images already installed on a system
Perform a complete image update
Retrieve the eligibility support status
Upload a cloud license file
Upload cloud license file content
Activate an off-box configuration
Modify the network port broadcast domain MTU
Retrieve action parameters
Enable capacity tiering
Retrieve the system cost and usage
Trigger subscription synchronization
Retrieve system ONTAP savings
Retrieve extra capacity licenses
Update extra capacity licenses
Register an extra capacity license
Update extra capacity license serial numbers
Register extra capacity license serial numbers
Delete extra capacity licenses using the license serial numbers
Update the default Vscan file operation profile
Update the NetApp Console password
Update the tier level
Update a BYOL license to a capacity-based license
Enable SnapLock on a system
Set up an NTP server
Start a Cloud Volumes ONTAP instance
Retrieve the support registration status
Register a Cloud Volumes ONTAP system with NetApp
List the start/stop schedules for Cloud Volumes ONTAP
Set the schedules for Cloud Volumes ONTAP
Activate FPolicy for ransomware files
Disable FPolicy for ransomware files
Delete FPolicy for ransomware files
Retrieve editable tags for cloud resources
Modify user tags for cloud resources
Activate snapshot policy assignment for unprotected read/write volumes
Create a snapshot policy
Update the serial number of a system
Parse an uploaded cloud license file
Set the cluster password for a system
Google Cloud systems (single-node)
Retrieve Cloud Volumes ONTAP systems
Create a new Cloud Volumes ONTAP system
Delete an SVM
Retrieve a Cloud Volumes ONTAP system
Delete an existing Cloud Volumes ONTAP system
Modify the SVM name
Create a new SVM
Retrieve a CIFS configuration
Set up a new CIFS configuration
Delete a CIFS configuration
Validate prerequisites for converting a system
Retrieve a list of upgrade versions
Set the writing speed
Retrieve all license types and their associated instance types
Set the instance type
Retrieve images already installed
Perform a complete image update operation
Retrieve the eligibility support status
Upload a cloud license file
Upload cloud license file content
Activate an offbox configuration
Modify the network port broadcast domain MTU
Retrieve the action parameters
Enable capacity tiering
Retrieve system cost and usage
Trigger subscription synchronization
Retrieve system ONTAP savings
Retrieve extra capacity licenses
Update extra capacity licenses
Register extra capacity licenses
Update extra capacity serial numbers
Register extra capacity serial numbers
Delete extra capacity licenses by serial numbers
Update the default Vscan file operation profile
Update the NetApp Console password
Update the tier level
Update a BYOL licence to a capacity-based license
Enable SnapLock for a system
Set up an NTP server
Start a Cloud Volumes ONTAP instance
Stop a Cloud Volumes ONTAP instance
Retrieve the registration support status
Register a Cloud Volumes ONTAP system
List the start/stop schedules
Set the schedules for Cloud Volumes ONTAP
Activate the FPolicy for ransomware files
Disable the FPolicy for ransomware files
Delete the FPolicy for ransomware files
Retrieve editable tags
Modify user tags for cloud resources
Activate snapshot policy assignment
Create a snapshot policy
Update the serial number of Cloud Volumes ONTAP
Parse an uploaded cloud license file
Set the cluster password
Google Cloud volumes (HA)
Retrieve volumes for backup activation
Retrieve quotes for a new volume
Update the underlying volume tier
Modify a volume
Delete a volume
Add an export policy rule
Retrieve a list of snapshot descriptions
Retrieve all igroups
Retrieve all iSCSI initiators
Add an iSCSI initiator
Retrieve volumes
Create a new volume
Clone an existing volume
Create a snapshot
Delete a snapshot
Move an existing volume
Google Cloud volumes (single-node)
Retrieve volumes for backup activation
Retrieve quotes for a new volume
Update the underlying volume tier
Modify a volume
Delete a volume
Add an export policy rule
Retrieve a list of snapshot descriptions for a volume
Retrieve all igroups
Retrieve all iSCSI initiators
Add an iSCSI initiator
Retrieve volumes
Create a new volume
Clone a volume
Create a snapshot
Delete a snapshot
Move a volume
Monitoring operations
Deploy a monitoring instance by systems
Retrieve monitoring information
Disable monitoring
Enable monitoring
NetApp Console
Check for a new version of the NetApp Console
Perform a fetch and process of image update metadata files
Perform a fetch and cache of Cloud Volumes ONTAP and NetApp Console files
Retrieve supported regions for the cloud providers
Activate the Cloud Volumes ONTAP capacity automatic management cycle
Trigger sending daily notifications
Retrieve feature flags
Retrieve the NetApp Console feedback configuration
Retrieve the NetApp Console server information
Retrieve the NetApp Console support services information
Update the NetApp Console
Restart the server
Update the NetApp Console with the specified patch version
Retrieve the region, VPC, and subnet
NetApp Console AutoSupport
Retrieve the signed URL for the NetApp Console support data
Retrieve the AutoSupport configuration
Update the AutoSupport configuration
Download a compressed file of all the AutoSupport files from all VSAs
Send performance archive support data to NetApp support
Download NetApp Console support data
Send NetApp Console support data to NetApp support
Send Cloud Volumes ONTAP support data to NetApp support
NetApp Console CA certificates
Retrieve all key manager CA certificates
Add a new key manager CA certificate
Retrieve a key manager CA certificate
Delete a key manager CA certificate
NetApp Console SaaS marketplace
Attach a SaaS subscription
Retrieve SaaS marketplace subscriptions
Retrieve current SaaS marketplace accounts and subscriptions
NetApp Console certificate signing requests
Retrieve a generated certificate signing request
Generate, store, and return a certificate signing request
NetApp Console certificates
Retrieve the installed certificate
Validate and install a certificate
NetApp Console configuration
Retrieve NetApp Console configuration parameters
Configure modifiable NetApp Console parameters
NetApp Console identity and access management
Associate a console agent with a workspace
Update the current NetApp Console service user
Retrieve visible workspaces
NetApp Console initial setup
Validate a proxy URL
Validate an active internet connection
Register NetApp Console to a dark site
Perform an initial setup with NetApp Console
Perform an initial standalone setup with the local identity provider
Complete the setup
Register NetApp Console
Set up a proxy URL
Confirm the NetApp Console active internet connection
NetApp Console key managers
Retrieve a key manager using the public ID
Update an existing key manager
Delete an existing key manager
Retrieve all key managers
Add a new key manager
NetApp Console key store
Generate a new key pair and self-signed certificate
Generate a new key pair and self-signed certificate at the key store
Generate a new key pair and self-signed certificate at the key store
Validate and install the provided root CA chain
Validate and install the certificate in the trust store
Retrieve the CA signed certificate
Validate and install the provided root CA chain
Retrieve the self-signed certificate of the NetApp Console key store
Return the existing trusted certificates from the trust store
Delete an existing trusted certificate from the trust store
On-premises ONTAP cluster aggregates
Retrieve aggregates
On-premises ONTAP cluster metadata
Verify the address and credentials of a cluster
On-premises ONTAP cluster systems
Set up AWS backup to cloud
Set up Azure backup to cloud
Set up Google Cloud backup to cloud
Set up StorageGRID backup to cloud
Retrieve an IPspace list for an existing system
Retrieve on-premises systems
Discover an on-premises system
Retrieve an on-premises ONTAP system
Delete an on-premises ONTAP system
Modify the NetApp Console password
Retrieve a CIFS configuration for a system
On-premises ONTAP cluster volumes
Retrieve volumes for backup activation
Modify an existing volume
Delete an existing volume
Retrieve a list of snapshot descriptions
Retrieve volumes
Create a new volume
Clone an existing volume
Create a snapshot
Delete a snapshot
Replication
Create a new replication for an FSx system
Create a new replication for an on-premises system
Create a new replication for a Cloud Volumes ONTAP system
Resync a SnapMirror replication relationship
Update the destination endpoint of the SnapMirror relationship
Remove a replication relationship
Initialize an existing SnapMirror relationship
Reverse an existing SnapMirror relationship
Modify a SnapMirror replication relationship
Return pairs of relationships
Break a SnapMirror replication relationship
Retrieve the replication schedules of a system
Retrieve the intercluster LIFs
Retrieve the status of all SnapMirror relationships
Retrieve SnapMirror replication relationship status
Replication metadata
Retrieve SnapMirror policies
Retrieve SnapMirror policies
Return a list of snapshot labels
Tenant operations
Retrieve a tenant
Update an existing tenant
Delete an existing tenant
Link a tenant to a NetApp support site account
Retrieve tenants
Create a new tenant
User management
Retrieve a user
Update an existing user
Delete an existing user
Add a NetApp Cloud Central user to NetApp Console
Reset the password
Grant or revoke permissions to a user
Remove a user from NetApp Console
Retrieve all users
Create a new user
User management authentication
Retrieve user representation
Update the user password
Sign out of the NetApp Console
Sign in to the NetApp Console
Accounts (tenancy)
Overview
Account
Account overview
Create an account
Delete an account
Retrieve an account
Associate a user
Dissociate a user
Retrieve user data
Retrieve service account data
Retrieve user and service account data
Retrieve user role and permissions
Delete a user
Enable Cloud Manager notifications
Retrieve user accounts
Move account data
Rename an account
Enable private preview for SaaS
Enable third-party services
Authorize
Authorize overview
Authorize an external resource
Authorize an external agent
Authorize an agent workspace
Authorize a user as account admin
Authorize a user for an account
Authorize an agent
Resource
Resource overview
Discover an external resource
Create an external resource
Retrieve a resource
Delete a service resource
Set a cloud identifier
Set a resource name
Add a resource to a workspace
Remove a resource from a workspace
Remove a resource from an agent
Delete a resource from an account
Update properties
Delete service resources
Service account
Service account overview
Create a service account
Delete a service account
Update details
Generate a secret
User
User overview
Retrieve users authorized for single resource
Retrieve users authorized for all resources
Workspace
Workspace overview
Create a workspace
Add a user
Remove a user
Delete a workspace
Rename a workspace
Add an agent
Remove an agent
Retrieve agents
Retrieve workspaces
Retrieve user account workspaces
Amazon FSx for NetApp ONTAP management
Overview
AWS credentials
AWS credentials overview
Retrieve AWS credentials
Add AWS credentials
AWS operations
AWS operations overview
Retrieve VPCs
Retrieve route tables
Retrieve encryption keys
Retrieve supported regions
FSx ONTAP discovery
FSx ONTAP discovery overview
Discover FSx ONTAP systems
Working environments
Working environments overview
Retrieve working environments
Create FSx for ONTAP working environments
Discover working environments
Retrieve volumes
Retrieve ONTAP credentials
Create ONTAP credentials
Recover working environments
Retrieve working environments by account
Delete an FSX working environment
Remove working environment from workspace
Update FSx ONTAP systems
Audit
Overview
Retrieve account records
Retrieve audit options
Retrieve records by service
Backup and Recovery
Overview
Backup
Backup overview
Retrieve system details
Retrieve the details of all the systems that are backed up
Retrieve specific system details
Unregister a system
Retrieve the backup status
Modify the Backup and Recovery service backup configuration
Retrieve volume information
Modify a backed up volume
Remove backup settings
Enable backup for a volume (v3)
Retrieve volume details
Modify multiple backed up volumes
Retrieve specific snapshot information for a volume
Delete a snapshot
Retrieve snapshot information for a volume
Delete all snapshots (volume)
Retrieve a list of snapshots using the account ID
Delete all snapshots (system)
Retrieve snapshot information for a volume
Catalog
Catalog overview
Configure a service
Re-index the catalog for all of the systems in an account
Search a specific file
Search for a specific file (on premises)
Retrieve snapshots
Enable or disable the service
Cloud
Cloud overview
Retrieve AWS accounts
Retrieve subscribed AWS regions
Retrieve AWS keys
Retrieve AWS private links
Retrieve AWS storage classes
Retrieve a list of AWS S3 buckets from a region
Retrieve an AWS S3 bucket from a region
Retrieve regions
Create an Azure resource group
Retrieve Azure resource groups
Retrieve Azure virtual networks
Retrieve Azure subscriptions
Retrieve Azure vault keys
Retrieve Azure vaults
Retrieve a list of Azure storage accounts for a subscription ID
Retrieve a specific Azure storage account for a subscription ID
Retrieve Google Cloud projects
Retrieve Google Cloud regions
Retrieve a list of KeyRings for a region
Retrieve a list of CryptoKeys
Retrieve a list of Google Cloud buckets in a region
Retrieve a Google Cloud bucket in a region
List Google Cloud credentials
Register Google Cloud credentials
Update Google Cloud credentials
Delete Google Cloud credentials
Configuration
Modify the configuration
Retrieve the configuration value for the specified key
Features
Retrieve a list of features which are enabled or disabled for the account
Job
Job overview
Retrieve jobs
Retrieve particular job details
License
License overview
Retrieve license validity
Verify the valid licenses in a system
Migration
Validate migration operations
Trigger backup migration
Object storage
Create a bucket for a cloud provider
Modify bucket properties for a cloud provider
Retrieve buckets for a cloud provider
Retrieve a bucket for a cloud provider
Panoramic protection
Panoramic protection overview
Activate comprehensive protection in a system (v1)
Modify the comprehensive protection configuration in a system (v2)
Enable comprehensive panoramic protection for multiple volumes (v1)
Modify comprehensive protection for multiple volumes (v1)
Ransomware scan
Ransomware scan overview
Initiate a ransomware scan
Replication
Replication overview
Perform an action on a volume with SnapMirror replication
Report
Report overview
Generate an inventory report
Retrieve inventory report data
Retrieve the local snapshots report
Retrieve replication report data
Restore
Restore overview
Perform a volume and file-level restore (v2)
Perform a volume, file, and folder-level restore operation (v3)
Revert a snapshot for a volume
SFR
SFR overview
Start a file and folder explore operation (v1)
Retrieve a list of files and folders
Retrieve the file and folder status
StorageGRID
StorageGRID overview
Retrieve StorageGRID server version
Discover a new StorageGRID WebScale server
Save StorageGRID credentials
Retrieve a list of StorageGRID buckets
Retrieve details of a bucket from the StorageGRID server
List StorageGRID servers
Register new StorageGRID credentials
Update StorageGRID credentials
Delete StorageGRID credentials
System
System overview
Retrieve ONTAP backup policies
Create a backup policy
Delete a backup policy
Update a backup policy (v2)
Retrieve IP spaces
Retrieve systems
Retrieve system details
Retrieve a list of storage VMs
Retrieve volumes
Configure object storage (v2)
Retrieve system volume directories
Retrieve an object store configuration status
List the snapshot policies associated with a system
Delete a snapshot policy using the UUID
Retrieve a list of ONTAP replication policies
Create a replication policy in a system
Delete a replication policy
Modify a replication policy in a system
Retrieve a list of ONTAP relationships associated with a system
Retrieve a list of ONTAP clusters peered to a system
Retrieve a list of snapshot details for a volume
Create a snapshot for a volume
Delete a snapshot for a volume
List the relationship details associated with a volume SnapMirror replication
Modify a snapshot policy
Retrieve a list of schedules in a system
Create a new cron schedule in a system
Create a snapshot policy
Modify the snapshot policy in a system
Discover all volumes with relationships for a list of systems
Copy and Sync
Overview
Accounts
Accounts overview
Retrieve the tenancy accounts
Delete the current account
Retrieve the account information
Register an account to a marketplace
Retrieve the logged-in accounts relationship status
Add NetApp support site credentials
Retrieve NetApp support site credentials
Add a license
Retrieve a list of all licenses
Retrieve license settings
Delete a license serial number
Delete NetApp support site credentials
Data brokers
Data brokers overview
Retrieve all the data brokers
Create a new installer for the NetApp data broker instance
Delete an existing NetApp data broker
Restart a data broker
Update the proxy configuration for a data broker
Move the data broker between groups
Retrieve the CIFS shares
Retrieve the CIFS server folders
Retrieve the NFS server folders
Retrieve the NFS server folders by ID
Retrieve the S3 buckets
Retrieve the S3 bucket folders
Retrieve the StorageGRID buckets
Retrieve the StorageGRID bucket folders
Retrieve the IBM buckets
Retrieve the IBM bucket folders
Retrieve the ONTAP S3 buckets
Retrieve the ONTAP S3 bucket folders
Retrieve the Alibaba buckets
Retrieve the Alibaba bucket folders
Retrieve the Azure blob storage containers
Retrieve the Azure blob storage container folders
Retrieve the Google Cloud buckets
Retrieve the Google Cloud bucket folders
Retrieve the AWS KMS keys
Retrieve the S3 private links
Retrieve the data broker local configuration
Groups
Groups overview
Retrieve all groups
Download the data broker group logs
Modify the group settings
Retrieve the SFTP root directory
Retrieve the SFTP server folders
Retrieve the CIFS shares
Retrieve the CIFS server folders
Retrieve the NFS server exports
Retrieve the NFS server folders
Retrieve the AWS KMS keys
Retrieve the S3 buckets
Retrieve the S3 bucket folders
Retrieve the StorageGRID buckets
Retrieve the StorageGRID bucket folders
Retrieve the ONTAP S3 buckets
Retrieve the ONTAP S3 bucket folders
Retrieve the IBM buckets
Retrieve the IBM bucket folders
Retrieve the Alibaba buckets
Retrieve the Alibaba bucket folders
Retrieve the Azure blob storage containers
Retrieve the Azure blob storage container folders
Retrieve the Azure Data Lake Gen2 storage containers
Retrieve the Azure Data Lake Gen2 storage container folders
Retrieve the Google Cloud buckets
Retrieve the Google Cloud bucket folders
Retrieve the Google Cloud KMS keys
Retrieve the Google Drives
Retrieve the Google Drive folders
Retrieve the Box API root folder
Retrieve the Box API server folders
Retrieve the S3 private links
Delete a data broker group
Messages
Messages overview
Retrieve the asynchronous messages
Relationships
Relationships overview
Retrieve all relationships
Create a new relationship
Retrieve a relationship
Update the settings for a relationship
Delete an existing relationship
Delete relationships
Initiate a relationship data sync
Stop the relationship data sync
Retrieve the relationship endpoints
Modify the source or target credentials
Edit the relationship tags
Reports
Reports overview
Create a new report
Retrieve a list of all reports
Delete the reports by a specified report ID
Retrieve a list of the reports endpoints
Retrieve a report by a specified ID
Storages
Storages overview
Retrieve the storage type
Timelines
Timelines overview
Retrieve timelines
Credentials
Overview
AWS
AWS overview
Add AWS credentials
Update AWS credentials
Retrieve credentials by ID
Azure
Azure overview
Add service principal credentials
Update service principal credentials
Retrieve credentials by ID
Generate token from ID
Generate Azure token
Generic
Generic overview
Add generic credentials
Retrieve credentials by type
Update generic credentials
Delete credentials
Retrieve credentials by ID
Licenses and subscriptions
Overview
Data services
Data services overview
Retrieve data service eligibility details
External services
External services overview
Retrieve on-prem ONTAP data
License
License overview
Associate a license
Update a license by serial number
Delete a license
Associate extra-capacity per-node licenses with a Cloud Volumes ONTAP system
Retrieve a license by type
Update a license by resource ID
Delete a license by resource ID
Exchange a Cloud Volumes ONTAP license
Update all licenses under an organization ID
Subscription
Subscription overview
Register a subscription
Retrieve all subscriptions for an account
Update a subscription expiration date using the subscription ID
Delete a subscription using the subscription ID
Retrieve the subscription entitlements
Retrieve subscription information for an account
Delete a subscription using the account ID
Associate a subscription
Retrieve subscription information using the subscription ID (deprecated)
Update a subscription expiration date (deprecated)
Delete a subscription using the subscription ID (deprecated)
Associate a subscription (deprecated)
Retrieve subscription information using the subscription ID
Update a subscription expiration date
Retrieve the preferred subscription ID for an account
Update the preferred subscription ID for an account
Retrieve subscription configuration information
Set the subscription configuration
Retrieve the associated subscription ID for cloud accounts
Federation
Overview
Domain
Domain overview
List domains
Create a domain
Delete a domain
Retrieve a domain
Update a domain
Federation
Federation overview
List federations
Create a federation
Delete a federation
Retrieve a federation
Update a federation
Unmigrated connection
Unmigrated connection overview
List unmigrated connections
Import a connection
IPA
Overview
License
License overview
Register a license
Deregister a license
Retrieve license status
Retrieve IPA license status (v5)
Authenticate an IPA license (v5)
Retrieve IPA license status (v6)
NSS
NSS overview
Retrieve NetApp Support Site key credentials
Update NetApp Support Site key credentials
Delete NetApp Support Site key credentials
Retrieve a list of NetApp Support Site key credentials
Create NetApp Support Site key credentials
Create an IDaaS NetApp Support Site key credential
Associate a resource
Disassociate a resource
Update a resource NetApp Support Site key
Retrieve NetApp Support Site credentials
Retrieve an access token
Retrieve NetApp Support Site data for accounts
Retrieve NetApp Support Site data for an account and key ID
Services
Services overview
Retrieve an IPA serial number token
Retrieve an IPA serial number
Support
Support overview
Check system entitlements
Create a support case
Upload an attachment for a support case
Retrieve a temporary URL for file attachment
Retrieve support cases
Retrieve support case details
Update support case notes or status
Retrieve a list of case notes
Identity and access management
Overview
Hierarchy
Hierarchy overview
List all folders
Create a new folder
Delete a folder
Retrieve a folder
Update a folder partially
Update a folder
List all folders under a parent folder
Create a child folder under a parent folder
Remove a child folder from a parent folder
Retrieve a child folder under a parent folder
List all projects under a folder
Create a new project under a folder
Remove a project from a folder
Retrieve a project under a folder
Update a project under a folder partially
Modify a project under a folder
List all organizations
Create a new organization
Retrieve an organization
Update an organization partially
Modify an organization
List all folders under an organization
Create a new folder under an organization
Remove a folder from an organization
Retrieve a folder under an organization
Update a folder under an organization partially
Update a folder under an organization
Remove a child organization from a parent organization
List all projects under an organization
Create a new project under an organization
Remove a project from an organization
Retrieve a project under an organization
Update a project under an organization partially
Modify a project under an organization
List all projects
Create a new project
Delete a project
Retrieve a project
Update a project partially
Modify a project
Partnership
Partnership overview
List all partnerships
Create a new partnership
Delete a partnership
Retrieve a partnership
Update a partnership partially
List all grants for a partnership
Create a new grant
Delete a grant
Retrieve a grant
Permission
Permission overview
List all permissions
Retrieve a permission
List all permissions for a resource
List all permissions for a role
Retrieve a permission for a role
List all permissions for a user
List all permissions a user has for a resource
Retrieve a permission on a resource for a user
Resource and resourcegroup
Resource and resourcegroup overview
List all resources under a folder
Add resources to a folder
Remove a resource from a folder
Retrieve a resource under a folder
List all resource groups under an organization
Add resource groups to an organization
Remove a resource group from an organization
Retrieve a resource group under an organization
List all resources under an organization
Add resources to an organization
Remove a resource from an organization
Retrieve a resource under an organization
List all resources for a grant in a partnership
Add resources to a grant in a partnership
Remove a resource from a grant in a partnership
Retrieve a resource from a grant in a partnership
List all partnership types
Retrieve a partnership type
List all resources in a project
Add resources to a project
Remove a resource from a project
Retrieve a resource in a project
List all resource groups
Create a new resource group
Delete a resource group
Retrieve a resource group
Update a resource group
Modify a resource group
List all resources for a resource group
Add resources to a resource group
Remove a resource from a resource group
Retrieve a resource in a resource group
List all resources
Create a new resource
Delete a resource
Retrieve a resource
Update a resource
Modify a resource
List all partnership organizations for the specified user
List all resources for a user with a permission
Retrieve a resource for a user with a permission
List all resources for a user
Check if a user has permission for a resource
Role
Role overview
List all roles
Retrieve a role
List all the roles for a user
User and usergroup
User and usergroup overview
Create a new user group in a folder
Remove a user from a folder
List all users for a folder
Add users to a folder
Remove a user from a folder
Retrieve a user associated with a folder
Create a new user group in an organization
Associate users in an organization with a role
Remove a user from an organization
Create a new service account
Delete a service account
Retrieve a service account
Update a service account partially
Modify a service account
Create a new client secret for a service account
List all the public keys for a service account
Create a public key for a service account
Delete a public key for a service account
Partially update a public key for a service account
List all user groups under an organization
Add user groups to an organization
Remove a user group from an organization
Retrieve a user group under an organization
List all users under an organization
Add users to an organization
Remove a user from an organization
Retrieve a user under an organization
Modify a user
List all users for a grant in a partnership
Add users to a grant in a partnership
Remove a user from a grant in a partnership
Retrieve a user with a grant in a partnership
List all users for a partnership
Add users with the ResourceAdmin role to a partnership
Remove a user from a partnership ResourceAdmin group
Retrieve a user in a partnership ResourceAdmin group
List all users with the UserAdmin role in a partnership
Add users to the UserAdmin role in a partnership
Remove a user from the UserAdmin group in a partnership
Retrieve a user in the UserAdmin group in a partnership
List all users for a partnership
Add users to a partnership
Remove a user from a partnership
Retrieve a user in a partnership
Create a new user group in a project
Remove a user from a project
List all users for a project
Add users to a project
Remove a user from a project
Retrieve a user under a project
List all users with a specific permission for a resource
Retrieve a user with a permission for a resource
List all users with permissions for a resource
List all user groups
Create a new user group
Delete a user group
Retrieve a user group
Update a user group partially
Modify a user group
List all users for a user group
Add users to a user group
Remove a user from a user group
Retrieve a user in a user group
List all users
Create a new user
Delete a user
Retrieve a user
Update a user partially
Modify a user
Automation technologies
Overview
Automation blogs
Knowledge and support
Additional resources
Legal notices