Skip to main content
Digital Advisor API

Migrate deprecated Digital Advisor REST API endpoints to GraphQL

Contributors netapp-aoife
PDFs

The transition from REST APIs to GraphQL APIs will be phased, with a period of overlap between REST APIs and GraphQL APIs. Learn how to identify and migrate deprecated REST API endpoints to GraphQL.

A deprecation notice will be published in the Digital Advisor API catalog for each deprecated REST API endpoint. You need to migrate that specific endpoint to GraphQL within six months.

Caution Due to the phased deprecation of Digital Advisor REST APIs, NetApp strongly recommends that all new API integrations use the GraphQL-based API.
About this task

  • You should first migrate the endpoints that already have the six-month deprecation notice before you migrate other endpoints. NetApp updates these first and provides confirmed GraphQL replacements.

  • GraphQL is organized around objects, not endpoints, which improves predictability. To understand the schema types, refer to the GraphQL Apollo Studio explorer.

Step 1: Learn how to replace REST API calls with GraphQL

To replace the REST API calls with GraphQL, you need to learn how to do the following:

  • Use queries instead of endpoints.

    GraphQL retrieves exactly the fields you need instead of fixed REST payloads (reducing over and under fetching). For more information, see Digital Advisor GraphQL API data queries and mutations.

  • Pass variables instead of URL parameters.

    GraphQL uses variables instead of URL parameters. For more information, see Use variables in a query.

  • Consolidate multiple REST API calls.

    With GraphQL, you can combine several requests into a single query and get all the data you need at once.

    Note Digital Advisor GraphQL APIs use the same authentication methods as the REST API for token generation. For more information, see Generate your Digital Advisor API access and refresh tokens.

Step 2: Identify deprecated REST API endpoints and their GraphQL replacement

Steps

  1. Review the Digital Advisor REST APIs that you are currently using in your integration.

  2. Navigate to Digital Advisor (ActiveIQ) and sign in using your NetApp Support Site credentials.

  3. In the top navigation bar, select Quick Links, and then select API Services.

  4. To review the list of APIs scheduled for deprecation, select Browse, and then select Deprecated APIs.

  5. From the list of deprecated APIs, confirm the following:

    • Whether an endpoint you are using in your integration is listed.

    • The expected retirement date for endpoints you are using.

  6. Review the Migration information section, which includes the equivalent GraphQL query that corresponds to each deprecated REST API endpoint. To view the equivalent GraphQL query, select Sample GraphQL Query in the table.

    Note Most of the REST API endpoints have a direct functional replacement available in GraphQL. Review each deprecated REST API endpoint to find the corresponding migration information.

Step 3: Test out the GraphQL API

You can use the GraphQL API Explorer tool to perform the following actions:

After you finish

After you've learned how to use the GraphQL API and validated the GraphQL version of your deprecated endpoint, update your automation code and scripts and discontinue the use of the deprecated REST call before its retirement date.