Programmability/REST API

Getting Started

In this topic any reference to API Application Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software. is for REST Representational State Transfer. REST is a simple and stateless architecture that the web services use for providing interoperability between computer systems on the Internet. In a RESTful web service, requests made to the URI of a resource will elicit a response that may be in XML, HTML, JSON or some other defined format. API. Any reference to Streaming API is mentioned as Streaming API.

For more information on programmability or REST API, please review the Developer Hub to learn more information about extensibility features.

What types of Programmable Interfaces are supported ?

REST API, Streaming API and Webhooks

Streaming API is supported under Advanced License only.

REST API

How do I access the Classic Central API gateway?

To access the Classic Central REST API gateway, see Classic Central API Gateway.

How do I generate an access token for REST API?

REST API access token is generated using the following methods:

Using API—Obtain an Access Token
Using API Gateway Web UI— Creating Application & Token

Generating access tokens via federated SSO Single Sign-On. SSO is an access-control property that allows the users to log in once to access multiple related, but independent applications or systems to which they have privileges. The process authenticates the user across all allowed resources during their session, eliminating additional login prompts. users is NOT supported.
Access token expires in 2 hours, expired tokens can be refreshed via an API call. Upon refresh, the previous token will be invalid and expiry time is not configurable.

What are the REST API rate limits?

API call limit is dynamic and based on number of subscribed devices in the account. However, the default API rate limit begins at 5000 (per day), 7 calls (per second).

For more information, see the Developer Hub guide under Usage & Rate Limits.

Configuring or acknowledging Webhooks via API will count toward the API rate limit. Streaming API and Webhook notifications or alerts will not count towards the REST API call limit.

Does HPE Aruba Networking offer tools to test REST API calls?

HPE Aruba Networking offers two web UI methods to test API calls:

Each method provides required parameters for API endpoint, expected API response and model schema.

Where can I find the API reference list ?

The API reference list can be found using two methods:

Swagger documentation via Classic Central UI

For detailed steps on accessing the API list using Swagger Documentation, see Swagger Documentation.
HPE Aruba Networking Developer Hub

For more information, see Central API Reference.

Ensure to use the Swagger documentation, as this method provides supported APIs based on Classic Central current software release. When using Developer Hub, review Changes to Classic Central APIs to identify new, modified, deprecated, or removed APIs between Central software releases.

How do I access the API gateway?

To access the API Gateway from the Classic Central UI:

In the Classic Central app, set the filter to Global.
Under Maintain, click Organization > Platform Integration.
Under the API Gateway tile, click Rest API.
Displays the API Gateway page.

The API Gateway portal allows you to run or test any API from portal UI. You can try different APIs and see their output before you decide on the API to use in your applications. To run an API, you will require an access token. You can obtain this access token from the Classic Central UI.

Where can I find a complete list of APIs that Classic Central offers?

To view the complete list of APIs, complete the following steps:

In the Classic Central app, set the filter to Global.
Under Maintain, click Organization > Platform Integration > Rest API.

The API Gateway page with the list of published APIs is displayed.
To view the Swagger interface, click the link in the Documentation column next to the specific published API name. The documentation is displayed in a new window.

What is Swagger? How is it related to Classic Central APIs and API Gateway?

Swagger is an open-source software framework that helps developers document and consume RESTful APIs. The API Gateway documents and publishes Classic Central APIs using the swagger open source framework.

For more information on Swagger, see https://swagger.io/

How do I get started with APIs? What are the high-level steps?

To get started with the APIs:

In the Classic Central app, set the filter to Global.
Under Maintain, click Organization > Platform Integration > Rest API.

The API Gateway page with the list of published APIs is displayed.
Click My Apps & Tokens tab.
Generate an access token.
Click the API Gateway link. The API Gateway portal opens.
From the URL drop-down, select the API category.
In the Token field, enter the access token.
Select the API.
Provide the required parameters.
Click Try.

For more information and step-by-step instructions on getting started with APIs, see the API Gateway.

What is an access token? How do I generate an access token from the Classic Central UI?

An access token is a string or a credential that identifies a user. To make an API request, the users must obtain an access token.

To generate an access token:

In the Classic Central app, set the filter to Global.
Under Maintain, click Organization > Platform Integration > Rest API.

The API Gateway page with the list of published APIs is displayed.
To create an access token, click + Add Apps & Token. The New Token pop-up window opens.
Select the application from the Application drop-down list and click Generate. An access token is created and listed in the Token List table.
Click Download Token to get access token details. The token details are displayed.
Note the refresh token. Access tokens expire in two hours. The refresh token can be used for refreshing the access token.

How long is the access token valid?

An access token is valid for two hours.

Can I change or extend the validity of the token?

No. The validity period for access tokens is fixed and not customizable.

My access token has expired. How do I renew it?

Access tokens are valid for a short time. You can refresh the access tokens using the refresh token string. To view the refresh token, click Download Token on the My Apps & Tokens page. The refresh token is valid for 14 days.

What are the primary things that I need to have for automating workflows using APIs?

You would need an access token and link to the API Gateway.

Can I automate device provisioning using APIs?

Yes, you can automate the entire device onboarding workflow using APIs.

Device onboarding includes the following steps:

Assigning subscriptions to the devices in your inventory—Use the APIs under the Licensing category.
Creating groups—Use the Groups APIs under the Configuration category.
Assigning devices to groups—Use the Devices APIs the Configuration category.

Are all the parameters listed for an API mandatory?

No, only the parameters marked as required are mandatory for an API.

Where can I find the sample request body?

When you select an API in the API Gateway portal, the panel on the right displays the sample request body.

Where can I find the sample response body?

When you select an API in the API Gateway portal, the right panel displays the sample response body. To view the structure of the response, click Response Schema.

Where can I find the documentation for the APIs?

The API documentation is available for the APIs on the API Gateway portal. When you select an API under a subcategory, the middle panel on the page shows the selected API and its description.

For generic information on how to get started with the APIs, API Gateway, and Webhook APIs, see the following documents:

Streaming API

REST API access token is generated using the following methods:

How do I generate an access token for Streaming API?

To generate Streaming API access token see Secure WebSocket Key.