• BlueXP API docs
• Get started
  • BlueXP 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
    • Connector and client identifiers
    • Use the REST APIs
• BlueXP 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
      • Working environments
        • Create a working environment with a capacity-based license
        • Create a working environment with PAYGO (node-based)
        • Create a working environment with BYOL (node-based)
        • Get working environments
        • Delete a working environment
        • 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
      • Working environments
        • Create a working environment with a capacity-based license
        • Create a working environment with PAYGO (node-based)
        • Create a working environment with BYOL (node-based)
        • Get working environments
        • Delete a working environment
        • 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
      • Working environments
        • Create a working environment with a capacity-based license
        • Create a working environment with PAYGO (node-based)
        • Create a working environment with BYOL (node-based)
        • Get working environments
        • Delete a working environment
        • 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
    • Working environments
      • Get working environments
      • Discover working environments
    • 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 working environment
      • Get intercluster LIFs
      • Get schedules for working environment
      • Get SnapMirror policies
      • Get SnapMirror SVM policies
  • API reference
    • Resources
    • Definitions
• 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
  • 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
  • Audit
    • Audit overview
    • Retrieve account records
    • Retrieve records by service
    • Retrieve audit options
• Backup and recovery
  • Overview
  • Backup
    • Backup overview
    • Retrieve working environment details
    • Retrieve specific working environment details
    • Enable the BlueXP backup and recovery service
    • Modify the BlueXP backup and recovery service
    • Unregister a working environment
    • Retrieve the backup status
    • Enable BlueXP backup and recovery (v2)
    • Modify BlueXP backup and recovery service backup configuration
    • Enable BlueXP backup and recovery (v3)
    • Enable backup for a volume
    • Retrieve volume information
    • Modify a backed up volume
    • Remove backup settings
    • Enable backup for a volume (v2)
    • Enable backup for a volume (v3)
    • Retrieve volume details
    • Enable backup of multiple volumes
    • Modify multiple backed up volumes
    • Enable backup for multiple volumes (v2)
    • Retrieve Snapshot copy information
    • Delete a Snapshot copy
    • Retrieve Snapshot copy information
    • Delete all Snapshot copies (volume)
    • Delete all Snapshot copies (working environment)
  • Catalog
    • Catalog overview
    • Configure a service
    • Configure a service
    • Search a specific file
    • Retrieve Snapshot copies
    • 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 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 GCP projects
    • Retrieve GCP regions
    • Retrieve a list of KeyRings for a region
    • Retrieve a list of CryptoKeys
  • Job
    • Job overview
    • Retrieve jobs
    • Retrieve particular job details
  • License
    • License overview
    • Retrieve license validity
  • Ransomware Scan
    • Ransomware Scan overview
    • Initiate a ransomware scan
  • Restore
    • Restore overview
    • Perform a volume and file-level restore
    • Perform a volume and file-level restore (v2)
    • Perform a volume, file, and folder-level restore operation (V3)
    • Retrieve volume-level restore status
  • Sfr
    • Sfr overview
    • Start a file explore operation
    • Start a file and folder explore operation
    • Start a file and folder explore operation (v1)
    • Retrieve file explore status (v1)
    • Retrieve file explore status (v2)
    • Retrieve files (v1)
    • Retrieve files (v2)
    • Retrieve a list of files and folders
  • StorageGRID
    • StorageGRID overview
    • Retrieve StorageGRID server version
    • Retrieve StorageGRID WebScale servers
    • Discover a new StorageGRID WebScale server
    • Save StorageGRID credentials
  • Working environment
    • Working environment overview
    • Retrieve ONTAP backup policies
    • Create a backup policy
    • Update a backup policy
    • Update a backup policy
    • Retrieve IP spaces
    • Retrieve working environments
    • Retrieve working environment details
    • Retrieve storage VMs
    • Retrieve a list of storage VMs
    • Retrieve volumes
    • Configure object storage
    • Configure object storage (v2)
    • Retrieve working environment volume directories
    • Retrieve an object store configuration status
• 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
    • Abort 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
• Digital wallet
  • 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
    • Retrieve a license by type
    • Update a license by resource ID
    • Delete a license by resource ID
    • Exchange a Cloud Volumes ONTAP license
  • Subscription
    • Subscription overview
    • Register a subscription
    • Retrieve subscription information
    • Update a subscription expiration date
    • Delete a subscription
    • Retrieve the subscription entitlements
    • Retrieve the subscription information
    • Delete a subscription
    • Associate a subscription
    • Retrieve the subscription information of a specified subscription
    • Update subscription expiration date
    • Delete a subscription
    • Associate a subscription
    • Retrieve subscription information
    • Update a subscription expiration date
• 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 NSS key credentials
    • Update NSS key credentials
    • Delete NSS key credentials
    • Retrieve a list of NSS key credentials
    • Create NSS key credentials
    • Create an IDaaS NSS key credential
    • Associate a resource
    • Disassociate a resource
    • Update a resource NSS key
    • Retrieve NSS credentials
    • Retrieve an access token
    • Retrieve NSS data
    • Retrieve NSS data
  • Services
    • Services overview
    • Create an IPA serial number token
    • Create 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 to attach file
    • Retrieve support cases
    • Retrieve support case details
    • Update support case notes or status
• Identity and access management (IAM)
  • 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
    • Delete an 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
    • 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
  • 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 resource groups in the folder
    • Add resource groups to a folder
    • Remove a resource group from a folder
    • Retrieve a resource group in a folder
    • 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 resource groups under a project
    • Add resource groups to a project
    • Remove a resource group from a project
    • Retrieve a resource group under a project
    • 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 resources 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
    • Remove a user from a folder
    • List all user groups in a folder
    • Add user groups to a folder
    • Remove a user group from a folder
    • Retrieve a user group in 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
    • 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 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
    • Remove a user from a project
    • List all user groups in the project
    • Add user groups to a project
    • Remove a user group from a project
    • Retrieve a user group under 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 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