• Product and Solutions
  • Support and Training
  • Cloud Central
  • Community
  • Blog
  • Customer Stories
  • Contact
Menu bars
netapp-mark netapp-logo 
All BlueXP documentation
  • BlueXP API docs
  • Get started
    • Platform overview
    • 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
  • Common workflows and tasks
    • Get required identifiers
    • Create user token
    • Register service
    • Create service token
    • Generate NSS user ID
  • Cloud Volumes ONTAP
    • Overview
    • Get started
      • Prepare
      • Typical deployment
      • Hello world
      • Workflow processes
    • REST implementation details
    • AWS workflows
      • Before you begin
      • Working environments
        • Create working environment with capacity-based license
        • Create working environment with PAYGO (node-based)
        • Create working environment with BYOL (node-based)
        • Get working environments
        • Delete working environment
        • Create CIFS
        • Get CIFS
        • Delete CIFS
      • Aggregates
        • Add capacity to EV aggregate
        • Get aggregates
        • Create aggregate
        • Add disks to aggregate
        • Delete aggregate
      • Volumes
        • Create a volume using NFS
        • Create a volume using CIFS
        • Create a volume using iSCSI
        • Get volumes
        • Modify volume
        • Delete volume
        • Create 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 AWS cloud provider account
    • Azure workflows
      • Before you begin
      • Working environments
        • Create working environment with capacity-based license
        • Create working environment with PAYGO (node-based)
        • Create working environment with BYOL (node-based)
        • Get working environments
        • Delete working environment
        • Create CIFS
        • Get CIFS
        • Delete CIFS
      • Aggregates
        • Get aggregates
        • Create aggregate
        • Add disks to aggregate
        • Delete aggregate
      • Volumes
        • Create a volume using NFS
        • Create a volume using CIFS
        • Create a volume using iSCSI
        • Get volumes
        • Modify volume
        • Delete volume
        • Create 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 Azure cloud provider account
    • GCP workflows
      • Before you begin
      • Working environments
        • Create working environment with capacity-based license
        • Create working environment with PAYGO (node-based)
        • Create working environment with BYOL (node-based)
        • Get working environments
        • Delete working environment
        • Create CIFS
        • Get CIFS
        • Delete CIFS
      • Aggregates
        • Get aggregates
        • Create aggregate
        • Add disks to aggregate
        • Delete aggregate
      • Volumes
        • Create a volume using NFS
        • Create a volume using CIFS
        • Create a volume using iSCSI
        • Get volumes
        • Modify volume
        • Delete volume
        • Create quote
        • Get iGroups
      • Metadata
        • Get GCP regions
        • Get permutations
        • Get tag keys
        • Create buckets
        • Get buckets
        • Get GCP packages
        • Get snapshot policies
        • Get supported features
        • Get supported capacity tiers
        • Get service accounts
        • Get projects
        • Get GCP encryption keys
        • Get disk types
        • Get instance types
        • Get VPCs
        • Get zones
    • Common workflows
      • Before you begin
      • Identity and access
        • Get supported services
        • Get cloud provider accounts
        • Get tenants
      • SaaS marketplace
        • Get SaaS marketplace account
        • Attach subscription
      • NetApp Support Site
        • Create NSS ID
        • Get NSS ID
        • Get NSS IDs
        • Delete NSS ID
      • Internal tasks and support
        • Get active task
      • SnapMirror replication
        • Create relationship
        • Update relationship
        • Delete relationship
        • Get relationships
        • Get relationships status
        • Get relationship status for working environment
        • Get intercluster LIFs
        • Get schedules for working environment
        • Get SnapMirror policies
        • Get SnapMirror SVM policies
    • API reference
      • Resources
      • Definitions
  • Audit service
    • Overview
    • Audit
      • Audit overview
      • Send audit information
  • Cloud Backup
    • Overview
    • Backup
      • Backup overview
      • Retrieve working environment details
      • Retrieve specific working environment details
      • Enable the Cloud Backup service
      • Modify the Cloud Backup service
      • Unregister a working environment
      • Retrieve the backup status
      • Enable Cloud backup (v2)
      • Modify Cloud backup service backup configuration
      • Enable Cloud Backup (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
  • Credentials service
    • 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 service
    • 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
  • FSx for ONTAP service
    • 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
  • IPA service
    • 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
  • Tenancy service
    • Overview
    • Account
      • Account overview
      • Create an account
      • Delete an account
      • Associate a user
      • Disassociate 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 SaaS
      • 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 a service resource
    • 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
  • Automation technologies
    • Overview
    • Automation blogs
  • Knowledge and support
    • Additional resources
  • Legal notices
  • docs.netapp.com
  • Cloud Docs
  • BlueXP
  • API

Search results

  • © 2023 NetApp, Inc.
  • Terms of Use
  • Privacy Policy
  • Cookie Policy
  • Cookie Settings
  • Send feedback about this page
  • blog blog@
  • community community@
  • twitter twitter@
  • facebook facebook@
  • linkedin linkedin@
  • youtube youtube@
  • slideshare slideshare@