A10 Harmony Operator Console APIs

As we are aware the Operator Console is most used with User Interface. However, the user can also use the APIs provided to perform all such tasks which can be done through UI. For example, when a new user subscribes our A10 Lightning Application Delivery System an activation email is sent to the customer. So the provider or sub-provider can use the Operator Console UI or the API to modify the email content or to set advanced options in the email server.

Below we are showing few example APIs from the Operator Console. The API method varies depending on the component we are referring in the Operator Console. To access the APIs click the i button on the right top corner of the dashboard screen.

Micro Service Dashboard API

The Micro Service dashboard displays the detailed information of the micro-services running. Hence, the API uses the GET method to fetch information from the services.

The figure below is the API used to get barista service information.

_images/image5.128.png

Code Sample:

.. gist:: https://gist.github.com/c-success/0238acfa567808e09d915ebb5f0d692e

Note

User gets the Authorization key in the Operator Console login API response, only if login is successful.

Configuration Management API

The Configuration Management allows the user to configure the A10 Lightning components. Hence, the API uses the POST method for configuration.

The figure below is the API used to configure the activation emails.

_images/image5.129.png

Code Sample:

.. gist:: https://gist.github.com/c-success/97573f89aeb5938eb450cf793a484e6e

Note

User gets the Authorization key in the Operator Console login API response, only if login is successful.

Analytics Configuration Management API

Harmony Controller Analytics enables Analytics auto-request log-rate adapter by default. When automatic log-rate is enabled, A10 HarmonyTM Controller periodically adjusts the log-rate configuration parameter of Thunder devices in ratio of traffic through the devices.

The feature can be enabled or disabled through an Operator Console API. POST call on config or analytics with key “rate.adapter.enabled” value set to disables this feature.

The figure below is the API used to enable analytics auto-request log-rate adapter.

_images/analytics-operatorconsole.png

Code Sample:

_images/analytics_payload.png