The ExtremeCloud IQ Controller REST API Gateway provides a single entry point between the external requesting clients and the multiple internal APIs that help install, access, manage, and extend applications that are supported by the ExtremeCloud IQ Controller platform. The Gateway API is based on RESTful principles and uses standard HTTP methods for requests and responses. API request and response bodies are formatted in JavaScript Object Notation (JSON).

You can use any language or library that can submit REST API requests and process JSON to query the Gateway API . Examples of languages and libraries that can build REST clients include:

• For Java, the Jersey library provides the reference implementation of JAX-RS, a Java standard for RESTful web services. The implementation includes a client library that can run directly on the JVM.
• For Python, the Requests and JSON libraries facilitate REST API applications.
• For .Net, the core language provides facilities for submitting HTTP requests, and .Net libraries include a serializer for JSON.
• For the Linux shell, Wget and cURL can execute REST API calls. Linux shell utilities, like awk and grep, can parse and process JSON.

You can also use tools like Postman, an easy-to-use Chrome extension for making HTTP requests.
Note: To submit API calls, your RESTful API consuming program needs to have logged in using credentials granting at least read permissions. Any administrator account can be used with the REST API but only user accounts with Full admin credentials can make configuration changes through the REST API.

The ExtremeCloud IQ Controller REST API Gateway supports the HTTP bearer authentication scheme in conjuntion with the OAuth 2.0 protocol to provide secure authorized access to the API. OAuth is an authorization framework that enables web, mobile, and desktop applications to access protected resources. Bearer authentication (aka token authentication) involves security tokens called bearer tokens. To begin, pass your client login credentials within a POST request to the management/v1/oauth2/token endpoint with the following JSON data and structure:

{
   "grantType": "password",
   "userId": "adminUserId",
   "password": "adminPassword",
   "scope": "..."
}

In exchange for these credentials, the ExtremeCloud IQ Controller authorization server issues tokens called bearer tokens that you need to include in the Authorization header when making subsequent REST API calls. Below is a sample response to the token request:

{
    "access_token": "f06f6f285e364e59fd317bd74da9e837",
    "token_type": "Bearer",
    "expires_in": 7200,
    "idle_timeout": 604800,
    "refresh_token": "3e33d8f724e69024811f1cf5869dbaf7",
    "adminRole": "FULL"
}

Note: Access tokens have a finite lifetime. The expires_in field in the response indicates the lifetime, in seconds, of the access token. For example, a value of 7200 indicates that the access token expires in two hours from the time the response was generated. The API endpoint issues a HTTP 401 Unauthorized status code when it detects an expired token.

To construct a REST API request, combine the following components:

When you POST or PUT data to the REST API server, set the Content-Type header to application/json. It can also be useful to set the following request headers:

• accept: application/json
• accept-encoding: gzip,deflate,br
• accept-language: en-US,en;q=0.8,und;q=0.6

The ExtremeCloud IQ Controller REST API Gateway returns standard HTTP response codes in addition to JSON-based error messages in the response body to help you identify the source of a problem:

The ExtremeCloud IQ Controller API follows the semantic versioning specification (Major.Minor.Patch). The Major version will be updated whenever we introduce breaking changes. The Minor and Patch versions will be incremented when we add functionality and backward-compatible updates.

Create and manage access control list information.

Retrieve and manage NSight server configuration.

Create and manage access points.