GuidesAPI ReferenceGitHubAirheads Developer Community
HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In

Getting Started with REST API

This section is a quick start guide to Aruba Central REST API. You'll be up and running in a jiffy!

Suggest Edits

Introduction

Getting started with REST API in Aruba Central involves

  • Adding an application in API Gateway to get access to REST APIs from your application.
  • Web UI and OAUTH based access token generation mechanism to authorize and authenticate your application for REST API services.
  • Refreshing expired access tokens via an API request without having to follow OAUTH process from the start.
  • Making API calls with access token

All the APIs are categorized into different sets based on the purpose they serve.

API Categories

Aruba Central supports the following categories of APIs for the managed devices.

API

Description

Monitoring

Gets network, client, and event details. It also allows you to manage labels and switches.

Configuration

Allows you to configure and retrieve the following:

  • Groups
  • Templates
  • Devices

AppRF

Gets Top N AppRF statistics.

Guest

Gets visitor and session details of the portal.

Device Inventory

Gets device details and device statistics.

Presence Analytics

It allows you to configure the Presence Analytics application. It also retrieves site and loyalty
data

Troubleshooting

Gets a list of troubleshooting commands for a specific type of device.

Notification

Gets notification alerts generated for events pertaining to device provisioning, configuration,
and user management.

WAN Health

Allows you to the following:

  • Get the list of configured WAN health policies.
  • Create a new WAN health policy.
  • Delete an existing WAN health policy.
  • Get the details of any specific WAN health policy.
  • Update an existing WAN health policy.
  • Get policy schedule details.
  • Create a schedule for a WAN health policy.
  • Get statistics for WAN health cookie generated for a site.
  • Get WAN health test results.
  • Get WAN health test results for a specific site.
Network HealthIt allows you to get data for all the labels and sites.
VisualRFAllows you to retrieve information on floor plans, location of APs, clients and rogue devices.

For a complete list of API endpoints offered by Aruba Central, visit the API Reference page.

📘

Note

The term API endpoint referred throughout this document, in a nutshell, means an URL that allows an user to gain access to resources offered by the Aruba Central.

HTTP Request Methods

HTTP defines a set of request methods to indicate a desired action to be performed for a given API endpoint object. In Aruba Central, some API endpoints offer all of the following methods and some support only few of them. The purpose of each method is as described in the table below.

HTTP Request MethodsDescription
GETRetrieves target resource
POSTCauses change in state, creates an entity
PATCHApplies partial modification to a target resource
PUTReplaces the target resource with data in the HTTP Request payload
DELETEDeletes a resource

HTTP Status Codes

HTTP requests returns a status code that indicates whether an API call is success or not. In Aruba Central, API call responses contains standard HTTP status codes. To know about an API call's response status codes and its description, refer the "Response" dropdown text box for an API endpoint in API Reference Page.

2394

Response Codes for an API request

📘

Note

For more detailed information, follow the API section in Aruba Central Help

Updated 3 months ago

What’s Next