Use the API Explorer
Suggest changes
The API Explorer is integrated with the BlueXP API reference documentation, enabling you to test the various API endpoints while reviewing the documentation.
|
You can access the API Explorer by clicking Try it out on any of the API reference pages where it is supported. |
Before you begin
There are several things you should consider before using the API Explorer.
You need to have a NetApp BlueXP account. Refer to Learn about BlueXP accounts for more information.
There might be additional requirements depending on the API call. You might need to obtain the following identifiers from the BlueXP SaaS interface:
-
agentAuth ID or Connector ID
-
Service account client ID
-
Workspace public ID
See Get required identifiers for more information. You can pass the identifiers as input parameters to the API calls as needed.
You can use the API Explorer to issue REST calls for endpoints that require a user access token. API calls that require a service access token are not supported.
The Token usage field on an API reference page indicates the type of access token needed for each endpoint. See Basic concepts and terminology to understand the difference between these access tokens and other important concepts when accessing the BlueXP resources.
Issue a REST API call
The following steps provide an example of how to use the API Explorer to issue a typical REST API call.
-
Navigate to the Discover an external resource endpoint in the Tenancy service API documentation.
-
Select Try it out to open the API Explorer panel on the right side of the page.
-
Select Sign in which redirects the browser to the NetApp BlueXP website login page.
-
Enter your NetApp Cloud credentials, including the email address and password, and select Login or you can use your NetApp Support Site credentials to log in.
Use your single sign-on account for federated login. 
After successful authentication, you are redirected back to the Try this API panel.
-
Provide the required parameters, optional parameters, and request body information in the metadata section for the API call.
Refer to the parameter descriptions on the corresponding endpoint documentation page as needed. 
-
After you've entered all the parameters, click Submit to execute the API call .
At the bottom of the API Explorer panel, the equivalent curl command needed to execute the API call is displayed in the Code section along with the actual response in JSON format.
