Accessing theAOS-CXREST 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:

支持HTTPS请求的脚本和程序

A flexible way to access theAOS-CXREST 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 is a way to execute GET requests without writing a script. Using curl commands is a way to test REST requests that you are considering to incorporate into an application.

Browser-based interfaces such as Postman or theAOS-CXREST API Reference

Examples of browser-based interfaces include Postman and theAOS-CXREST API Reference.

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

TheAOS-CXREST API Reference is one way to execute GET requests without writing a script. TheAOS-CXREST 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.