Ways to access the ArubaOS-CX REST API

You can access the REST API using any REST client interface that supports HTTPS requests and supports obtaining and passing a session cookie.

Examples of client interfaces include the following:

Scripts and programs that support HTTPS requests

The most powerful way to access the ArubaOS-CX REST API is to use a programming language that supports HTTPS requests, such as Python, to write programs that automate network management tasks.

The curl command-line interface

You can use curl commands either interactively or within a script to make REST requests. Using curl commands can be a way to execute GET requests without writing a script. Using curl commands can be a way to test REST requests that you are considering incorporating into an application.

Browser-based interfaces such as Postman or the ArubaOS-CX REST API Reference

Examples of browser-based interfaces include Postman and the ArubaOS-CX REST API Reference.

The ArubaOS-CX REST API Reference documents the switch resources, parameters, and JSON models for each HTTPS method supported by the resource. Because the ArubaOS-CX REST API Reference is browser-based, it can share the session cookie with a Web UI session active in another browser tab. The ArubaOS-CX REST API Reference is not intended to be used as a configuration tool and is not required for day-to-day operations.

The ArubaOS-CX REST API Reference is one way to execute GET requests without writing a script. The ArubaOS-CX REST API Reference can be used during script coding to help you construct the URIs—with their query parameters—that you use in a script or curl command.