Modified APIs

The following table lists the APIs Application Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software. modified in the current release:

Table 1: Modified APIs

Modified API

Description

Authentication & Policy > User Policy

The API is enhanced to support the following:

  • Octa platform is supported along with Google and Azure.
  • A new parameter client_profile_tag is added to the body. On setting a valid client tag, you can configure the user policy with a rule to include the client_profile_tag along with the user group and client role. If client_profile_tag is not specified, the default value is set to Any in the user policy rule. This is an optional parameter.
  • [PUT]/cloudAuth/api/v1/user_policy

A new parameter client_profile_tag is added to the body.

On setting a valid client tag, you can configure the user policy with a rule to include the client_profile_tag along with the user group and client role. If client_profile_tag is not specified, the default value is set to Any in the user policy rule. This is an optional parameter.

Ble Beacon Service

A new parameter other_payload is added to configure the OpenLocate service. Openlocate is a self-locating wireless network that supports location coordination information (LCI) over BLE Bluetooth Low Energy. The BLE functionality is offered by Bluetooth® to enable devices to run for long durations with low power consumption.. This is a service-based configuration, pushed by Air Range to the Access Point. The config_menthod must be set to auto_generate, and the adv_format must be set to openlocate to configure the OpenLocate service.

OpenLocate feature is supported only for AOS-10.x group. The OpenLocate Beacon supports the following opons:

Measured Power and Geo Location options are default parameters, these parameters must be added in the other_payload body.

If you add Identity, then you must add at least one parameter in the identity_option body. The identity_option supports the following parameters:

  • serial_number
  • ap_name
  • ap_eth_mac
  • iot_radio_mac

If the URL and Signature are added in the other_payload body, then you must define the URL and passphrase values.

The values for the parameters defined in the other_payload body are updated by the device.

  • [GET] /ble_cfg_beacons/{group_name}
  • [GET] /ble_run_beacons/{group_name}
  • [GET] /ble_beacon_profiles

In the response body openlocate parameter displays the OpenLocate options that are configured using the following APIs:

  • config ble beacon profiles API—[POST] /ble_cfg_beacons/{group_name}
  • edit ble beacon profiles API[POST] /edit_beacon_profiles/{group_name}/{profile_id}

Configuration > AP Configuration

  • [GET]/configuration/v1/ap_cli/{group_name_or_guid_or_serial_number}
  • [POST]/configuration/v1/ap_cli/{group_name_or_guid_or_serial_number}

A new parameter syslocation is added to the response body. Use the syslocation parameter to add location information for the device.

To view the APIs modified in previous releases, see APIs Modified In Previous Releases.