HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In

API Swagger Interface

Accessing API Swagger documentation page

Aruba Central provides a link under its API Gateway section to its Swagger web interface which lists all the available Central APIs for the customers.

996996

Clicking on the API GW link shown in the figure above opens API Gateways swagger based interface

🚧

Note

The API GW link is unique based on which geographical cluster the customer's Aruba Central account resides on.

Below is the screenshot of Central API's swagger UI interface.

It has the following main features

  • Lists all the supported APIs
  • Required parameters for an API Endpoint
  • Expected API response sample and model schema
  • Try out an API endpoint in the Aruba Central and view the results.
28542854

The API Gateway's swagger interface can be used to try out different APIs

Trying out an API Endpoint

In order to try out the API using the API Gateway swagger interface, an access token needs to be provided in the Token textbox in the left panel. If you don't have an access token, refer to the previous section Obtaining Access Token

In this section, let's try out the Refresh Token API using Swagger web Interface.
For API reference click Refresh Token API

  • Choose Refresh Token API from the URL dropdown
  • Enter client_id, client_secret, grant_type and refresh_token in the respective fields
    • client_id and client_secret are obtained in the "Creating Application & Token" section
    • refresh_token value is obtained by downloading the access token JSON as mentioned in the previous section "Obtaining Access Token"
  • Click Try button.
22002200

Refresh Token API in Swagger Interface

You can view the result with a pop-up window as shown below

986986

Refresh Token API response in Web Interface

🚧

Note

After making a successful call to Refresh Token API, the existing access token which was refreshed will be invalid. You need to use the access token received as a response for this request. You can also obtain this token at later point of time by downloading it from API Gateway.

In this section, we learnt how to obtain access token using API Gateway and trying out refresh token API from swagger interface.


What’s Next

In the next section, let's learn about obtaining access token via API requests

Did this page help you?