HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

Create/Update match criteria for given classification rule_name

put
https://{api-base-url}/rapids-config/v1/node_list///config/classification_rules//match_criteria/

Config related to different critieria that will be matched to classify an API

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Defines the type of configuration node to which the config is being applied.

Allowed:
string
required

The value of the identifier for the configuration container. This value is interpreted according to node-type above. Invalid combinations of node-type and node-id will be rejected.

string
required

Unique name for this set of conditions

Body Params

JSON representation of match_criteria config

integer

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

integer

Minimum number of detecting APs to consider this AP for classification

string
enum

The classification value received from the detecting device

Allowed:
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
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
boolean

Match against all known valid SSIDs

boolean

AP ethernet MAC has been identified by an HP switch

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
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
string
enum

The radio band of the monitored AP

Allowed:
string
enum

Minimum encryption type used by this AP

Allowed:
boolean

Rogue BSSID matches exactly a known valid client MAC address

Responses

401

Unauthorized

403

Forbidden

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Updated about 2 years ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 years ago