Access APIs

To access the API Application Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software. , use the following URL Uniform Resource Locator. URL is a global address used for locating web resources on the Internet. :

https://apigw-<FQDN> of the HPE Aruba Networking Central instance>/.

This endpoint is accessible over SSL Secure Sockets Layer. SSL is a computer networking protocol for securing connections between network application clients and servers over the Internet. and the HTTP Hypertext Transfer Protocol. The HTTP is an application protocol to transfer data over the web. The HTTP protocol defines how messages are formatted and transmitted, and the actions that the w servers and browsers should take in response to various commands. (non-SSL) connections are redirected to the SSL port.

Table 1: Accessing the API

URL

Description

https://apigw-<FQDN> of the HPE Aruba Networking Central instance>/.

The API gateway URL. All APIs can be accessed from this URL by providing a correct access token.

The parameters for the API are as follows.

Table 2: Parameters for the API

Parameter

Value

Description

request_path

URL Path

URL path of an API, for example, to access monitoring APIs, use the path /monitoring/v1/aps.

Table 3: Header for the API

Header

Value

Description

Authorization

Bearer ouzMaXEBbB6XqGtsWomK7MvaTuhrqDQ1

Pass the access token in the header.

Example

Request Method: GET GET refers HTTP request method or an SNMP operation method. The GET HTTP request method submits data to be processed to a specified resource. The GET SNMP operation method obtains information from the Management Information Base (MIB).

https://apigw-<fqdn> of the HPE Aruba Networking Central instance>/monitoring/v1/aps

Request Header:

Authorization: Bearer ouzMaXEBbB6XqGtsWomK7MvaTuhrqDQ1

Response:

{ "aps": [ { "firmware_version": "6.4.4.4-4.2.3.1_54637", "group_name": "00TestVRK", "ip_address": "10.29.18.195", "labels": [ "Filter_242", "Ziaomof", "roster", "242455", "Diegso" ], "macaddr": "6c:f3:7f:c3:5d:92", "model": "AP-134", "name": "6c:f3:7f:c3:5d:92", "radios": [ { "band": 0, "index": 1, "macaddr": "6c:f3:7f:b5:d9:20", "status": "Down" }, { "band": 1, "index": 0, "macaddr": "6c:f3:7f:b5:d9:30", "status": "Down" } ], "serial": "AX0140586", "status": "Down", "swarm_id": "e3bf1ba201a6f85f4b5eaedeead5e502d85a9aef58d8e1d8a0", "swarm_master": true } ], "count": 1 }