User's Guide

Wireless Array
Using Tools on the Wireless Array 387
API Documentation
Arrays provide an API interface conforming to the RESTful API model.
Developers may use this read-only API to read status, statistics, and settings from
the Array. The interactive API Documentation page provides documentation for
the API.
You may use the Array’s API for purposes such as integrating with third party
applications or creating your own applications for network monitoring and
analysis. Using the RESTful API eliminates the need to use CLI scripting, or to use
SNMP which can be cumbersome for polling large amounts of data. Results are
returned in JSON format (JavaScript Object Notation), a text-based open standard
designed for human-readable data interchange. The API documentation is tightly
integrated with the server code. The API Documentation page allows you to
interact with the API in a sandbox UI that gives clear insight into how the API
responds to parameters and options.
Security for the API is provided with OAuth, as described in “OAuth 2.0
Management” on page 243. Once registration is completed and a permanent
token for this Array has been obtained, your application may access the RESTful
API using the client_id and the token at the following URL:
https://[Array hostname or IP address]/api/v1/[api-name] 
The API Documentation page lists all of the APIs that are available, lists their
calling parameters, if any, and allows you to perform sample calls and view
sample output.
Figure 186. API Documentation