Skip to main content

Aruba API

Aruba Central is a cloud-based network management platform for Aruba networking equipment. The Aruba API connector enables you to access Aruba Central via OAuth 2.0 access tokens, allowing you to retrieve audit logs, Wi-Fi connectivity metrics, AI insights, and other network management data from your Aruba Central deployment.

Aruba API icon

Power end-to-end data operations for your Aruba API API with Nexla. Our bi-directional Aruba API connector is purpose-built for Aruba API, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Aruba API or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Aruba API workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating an Aruba API credential, you'll need to register an OAuth 2.0 application in Aruba Central and obtain OAuth 2.0 client credentials. The Aruba Central API uses OAuth 2.0 for authentication.

Aruba Central OAuth 2.0 Setup

To obtain the required OAuth 2.0 credentials for Aruba Central:

  1. Sign in to Aruba Central: Navigate to https://central.arubanetworks.com/ and sign in to your Aruba Central account. If you don't have an account, you'll need to contact your Aruba administrator or sign up for Aruba Central.

  2. Access API Settings: Once signed in, navigate to the API settings or developer portal in Aruba Central. This is typically found in the account settings or developer section.

  3. Register OAuth 2.0 Application: Create a new OAuth 2.0 application in Aruba Central:

    • Click Create Application or Register Application
    • Provide a name and description for your application
    • Configure the application settings as needed
  4. Obtain Client Credentials: From your registered OAuth 2.0 application, obtain the following:

    • Client ID: The unique identifier for your OAuth 2.0 application
    • Client Secret: The secret key associated with your application
  5. Configure Redirect URI: Set up a redirect URI for your application. This URI must match the redirect URI you'll use in Nexla. The redirect URI is where Aruba Central redirects after successful authentication.

  6. Obtain Refresh Token (optional): If you want to use refresh tokens for automatic token renewal, you'll need to complete the OAuth 2.0 authorization flow to obtain an initial refresh token. This is typically done through a browser-based authorization flow.

Aruba Central uses OAuth 2.0 for API authentication. The Client ID and Client Secret are used to obtain access tokens. The redirect URI must match exactly between your Aruba Central application registration and the credential configuration in Nexla. For complete information about Aruba Central API authentication, see the Aruba Central API Documentation.

API Access Requirements

Aruba Central API access requires:

  • Valid Aruba Central Account: You must have an active Aruba Central account with API access enabled
  • OAuth 2.0 Application: A registered OAuth 2.0 application in Aruba Central
  • Client ID: The unique identifier for your OAuth 2.0 application
  • Client Secret: The secret key associated with your application
  • Redirect URI: The URI registered with your OAuth 2.0 application

The Aruba Central API uses OAuth 2.0 authorization code flow. Access tokens are obtained from the Aruba Central OAuth 2.0 token endpoint and are used in the Authorization header for API requests.

For complete information about Aruba Central API authentication and getting started, see the Aruba Central API Documentation.

Authenticate

Credentials required

Authenticate via OAuth2

FieldRequiredSecretDescription
Base URLYesNoBase URL of the Aruba Central API gateway
Client IDYesNoThe unique identifier for your OAuth2 application registered in Aruba Central. Required to request access tokens.
Client SecretYesYesThe secret key associated with your Aruba Central OAuth2 client. Used along with the Client ID to authenticate the application securely.
Redirect URIYesNoThe URI to which Aruba Central redirects after successful authentication. It must match the redirect URI registered with the application.
Refresh TokenNoYesOptional token used to obtain a new access token when the current one expires. Typically generated during the initial authorization flow.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Aruba

ArubaCred.png
  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  2. Enter the base URL for your Aruba Central API gateway in the Base URL field. The default value is https://apigw-prod2.central.arubanetworks.com. This should match your Aruba Central deployment's API gateway URL.

  3. Enter your Aruba Central OAuth 2.0 Client ID in the Client ID field. This is the unique identifier for your OAuth 2.0 application registered in Aruba Central.

  4. Enter your Aruba Central OAuth 2.0 Client Secret in the Client Secret field. This is the secret key associated with your OAuth 2.0 application.

  5. Enter the redirect URI in the Redirect URI field. This must match exactly the redirect URI registered with your OAuth 2.0 application in Aruba Central.

  6. If you have a refresh token from a previous OAuth 2.0 authorization flow, enter it in the Refresh Token field. This token can be used to obtain new access tokens when the current token expires.

    The OAuth 2.0 credentials are sensitive information that should be kept secure. Nexla will store these credentials securely and use them only for API authentication purposes. The Client ID and Client Secret are used to obtain access tokens from Aruba Central's OAuth 2.0 token endpoint. The redirect URI must match exactly between your Aruba Central application registration and this credential configuration.

  7. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Aruba API connector tile, then select the credential that will be used to connect to the Aruba Central instance, and click Next; or, create a new Aruba API credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Aruba Central endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Get All Audit Logs

This endpoint fetches audit logs in reverse chronological order from Aruba Central. Use this endpoint when you need to extract audit trail data, monitor system activity, or analyze network management events.

  • Optionally, enter a limit value in the Limit field to specify the maximum number of log entries to return per request. Leave empty to use the default limit.
  • Optionally, enter an offset value in the Offset field to specify the starting point for pagination. Leave empty to start from the beginning.
  • Optionally, enter a start time in the Start Time field to filter logs by start time. This should be in a format supported by the Aruba Central API.
  • Optionally, enter an end time in the End Time field to filter logs by end time. This should be in a format supported by the Aruba Central API.
  • Optionally, enter a username in the Username field to filter logs by specific user. Leave empty to retrieve logs for all users.
  • Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format.

Audit logs provide a comprehensive record of system activity and changes in Aruba Central. The endpoint returns logs in reverse chronological order, with the most recent entries first. For complete information about retrieving audit logs, see the Aruba Central Get Audit Logs API Documentation.

Get Wi-Fi Connectivity (Global Stage)

This endpoint retrieves Wi-Fi connectivity success percent and baseline metrics for a given stage and time period from Aruba Central. Use this endpoint when you need to analyze Wi-Fi performance, monitor connectivity metrics, or extract network analytics data.

  • Enter the connectivity stage in the Stage field. This should be a valid connectivity stage identifier (e.g., association, authentication, dhcp).
  • Enter the start time in the From field. This should be in a format supported by the Aruba Central API (typically ISO 8601 format or Unix timestamp).
  • Enter the end time in the To field. This should be in a format supported by the Aruba Central API.
  • Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format.
  • The endpoint returns overall success percent and connection metrics for the specified connectivity stage and time range.

Wi-Fi connectivity metrics provide insights into network performance at different stages of the connection process. The endpoint returns aggregated metrics for the global network across the specified time period. For complete information about Wi-Fi connectivity metrics, see the Aruba Central AIOps Wi-Fi Connectivity Global Documentation.

Get AI Insights (Global)

This endpoint retrieves a list of AI-driven insights for a network within a given time duration. Use this endpoint when you need to extract AI-generated network insights, analyze network anomalies, or monitor AI-detected issues.

  • Enter the start time in the From field. This should be in a format supported by the Aruba Central API (typically ISO 8601 format or Unix timestamp).
  • Enter the end time in the To field. This should be in a format supported by the Aruba Central API.
  • Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format.
  • The endpoint returns a list of AI insights generated by Aruba Central for the specified global network time window.

AI insights provide automated analysis and recommendations for network issues and optimizations. The endpoint returns insights generated by Aruba Central's AIOps capabilities for the specified time period. For complete information about AI insights, see the Aruba Central AI Insights Documentation.

Get Reporting Radio by MAC

This endpoint fetches reporting radio information for a specific radio MAC address from Aruba Central. Use this endpoint when you need to retrieve detailed radio information, analyze radio performance, or extract device-specific network data.

  • Enter the Radio MAC address in the Radio MAC field. This should be the MAC address of the radio device you want to retrieve information for.
  • Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format.
  • The endpoint returns detailed radio information including performance metrics, configuration, and status information.

Radio MAC addresses are unique identifiers for radio devices in Aruba Central. The endpoint returns comprehensive information about the specified radio device. For complete information about retrieving radio information, see the Aruba Central API Documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Aruba API data sources can also be manually configured to ingest data from any valid Aruba Central API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Aruba Central API URLs typically follow the format: https://apigw-prod2.central.arubanetworks.com/platform/auditlogs/v1/logs for audit logs, or https://apigw-prod2.central.arubanetworks.com/aiops/v1/connectivity/global/stage/{stage}/export for connectivity metrics. Replace the base URL with your Aruba Central API gateway URL if different. For the response data path, use $.data[*] to extract individual records from list responses (such as audit logs and AI insights), or $ to extract the entire object from single-object responses. The Accept header should be set to application/json for most Aruba Central API requests; authentication headers (OAuth 2.0 access tokens) are automatically included from your credentials. For complete information about Aruba Central API endpoints and response formats, see the Aruba Central API Documentation.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Aruba API data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.