Looking for product information? Visit arubanetworks.com

Working on a project and need a copy of the OpenAPI schema? View/download it here

Having trouble with the API explorer? Go to the Aruba Support Portal

Using the API Explorer

You should first log in to the AFC web interface which automatically sets up a session cookie through which this API Explorer can send authenticated requests to the AFC API.

API Authentication via HTTP Clients

To use this API from your chosen HTTP client, you'll first need to obtain an API key via POST /auth/token and use one of the following with subsequent requests that require authentication:

Leverage your client's session (cookie) support (via the Authorization key of the Cookie header)
Send the token as the value of the Authorization header

NOTE: the following header is deprecated and subject to removal in a future release:

Clients may automatically "refresh" their authentication token (extending its expiration time) by passing the X-Auth-Refresh-Token header with a value of true in any authenticated request.

API Response Formats

Unless specifically noted in the documentation for a given API call, this API sends response bodies in the JSON format. This must be expressed by HTTP clients using one of the following values in the Accept header:

application/json
*/*

API Versions

There are two ways to specify the Aruba Fabric Composer API version in your requests:

Include the value version=1.0 in the Accept header; for example: Accept: application/json; version=1.0 ensures that the API responds in the supported body format and uses API version 1.0
URL path; for example, to request API version 1: https://fabricmanager.example.com/api/v1

Generic Response Filtering

Generic object filtering is available for all API GET endpoints using the filter parameter. More information and examples here: Filtering API

Generic Responses

Unless specifically noted in the documentation for a given API call, the following responses can be returned:

401 Unauthorized response occurs when any of these conditions are present:
- User did not supply a token in one of the following headers:
  - Authorization (with or without the Bearer prefix)
  - Cookies (under the Authorization key)
- User supplied an unknown/expired token
- PKI User supplied a valid token created by a user which does not map to the client certificate supplied in the request
- PKI User supplied a valid token without supplying a client certificate
404 Not Found response occurs when all of these conditions are met:
- The API version is not specified in the request header
- The API version is not found in the URL
415 Unsupported Media Type response occurs when any of these conditions are present:
- The Content-Type header is missing from the request
- The Content-Type header has a value other than application/json

200Checkpoint rollback restored successfully

207Partial success of checkpoint rollback

400Invalid Input

401Error: Unauthorized

422Unprocessable request

500An internal error. See the error message for details