Retrieve Classification rule by rule_name

get https://{api-base-url}/rapids-config/v1/node_list/{node_type}/{node_id}/config/classification_rules/{rule_name}/

List of RAPIDS classification rules that are applied on APs.

Responses

Response body

object

rule_name

string

required

Unique name for this set of conditions

is_predefined

boolean

Defaults to false

This is a read-only field that indicates if a rule is pre-defined. Pre-defined rule cannot be modified or deleted . But it can be enabled or disabled and re-ordered

rule_enabled

boolean

Defaults to false

Apply these rule criteria or not

target_classification

string

Classification to apply to the AP if all criteria are met

ROGUE KNOWN_INTERFERING SUSPECT_ROGUE

match_criteria

object

min_signal

integer

Indicates the minimum signal strength for the AP to be considered for classification

detected_ap_count

integer

Minimum number of detecting APs to consider this AP for classification

wlan_classification

string

The classification value received from the detecting device

VALID INTERFERING DOS ROGUE KNOWN_INTERFERING SUSPECT_ROGUE

ssid_includes

array of objects

SSIDs to match for this classification rule. This criterion is matched if any of the SSIDs in the list are matched (even partially). For example: 'hpe' will match 'aruba-hpe' and 'aruba-hpe-guest'

ssid_includes

object

essid

string

required

Partial or complete SSID string that needs to be matched

ssid_excludes

array of objects

List of SSIDs to that are to be excluded from this classification rule. If if any of the SSIDs in the list are matched (even partially) the rule is not applied. For example: 'hpe' will match 'aruba-hpe' and 'aruba-hpe-guest'

ssid_excludes

object

essid

string

required

Partial or complete SSID string that needs to be matched

known_ssid_match

boolean

Match against all known valid SSIDs

plugged_into_network

boolean

AP ethernet MAC has been identified by an HP switch

monitored_time

integer

Minimum amount of time in minutes that the AP has to be active to consider it for classification

site_includes

array of objects

length ≤ 32

Apply this classification rule only to APs that are part of specified sites

site_includes

object

name

string

required

Name of site

site_excludes

array of objects

length ≤ 32

Skip this classification rule to APs that are part of specified sites. The same site must not be specified in both 'site_inlucdes' and 'site_excludes'.

site_excludes

object

name

string

required

Name of site

radio_band

string

The radio band of the monitored AP

BAND_2_4_GHZ BAND_5_GHZ BAND_6_GHZ

encryption

string

Minimum encryption type used by this AP

OPEN WEP WPA WPA2 WPA3

valid_client_match

boolean

Rogue BSSID matches exactly a known valid client MAC address

401

Unauthorized

403

Forbidden

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-base-url/rapids-config/v1/node_list/GLOBAL/node_id/config/classification_rules/rule_name/ \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400Bad Request

404Not Found

500Internal server error

defaultDefault response