Skip to main content

Prepare to use the API

Contributors netapp-ranuk dmp-netapp

You need to prepare before using the REST APIs provided with the ONTAP management service.

Have BlueXP credentials

You'll need a NetApp account to acquire an access token required to issue the REST API calls.

Review REST concepts and implementation

Review the REST implementation details for information about REST concepts and the details of how a REST API is designed.

Be familiar with Cloud Volumes ONTAP and ONTAP on-premises concepts

If you plan to perform Cloud Volumes ONTAP and on-premises ONTAP administration tasks, you should be familiar with the related ONTAP concepts, terminology, and procedures. Learn about Cloud Volumes ONTAP and on-premises ONTAP concepts.

Decide on the cloud provider and obtain credentials for Cloud Volumes ONTAP

Cloud Volumes ONTAP can be deployed in AWS, Microsoft Azure, and Google Cloud platform. You need to decide which of these providers you'll use and have the appropriate credentials.

Decide on the licensing model for Cloud Volumes ONTAP

You can create and manage Cloud Volumes ONTAP instances using a subscription PAYGO ("pay as you go") model or apply your own licenses with BYOL ("bring your own license"). You need to decide which licensing model you'll use and adjust the workflows as needed.

Prepare to use the workflow processes

Review Workflow processes for more information about the organization and content of the Cloud Volumes ONTAP and on-premises ONTAP workflows.

Note This documentation does not describe or use the legacy UI (not the SaaS UI).
Locate the identifiers

You'll need the identifier values for several of the workflows. See Get required identifiers for more information.

Additional considerations

Review the available resources described in Additional considerations.