createSiteWxTag
Create Site WxTag
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
uuidRequest Body
application/json
Request Body
WxLAN Tag
- type:
- client: created manually (e.g. on wireless client table, when they spot a device of interest, they can create a wxlan tag for it
- resource: created automatically when we discover a network resource
- subnet: create automatically when a subnet is discovered
- match:
- wlan_id, ap_id: values are a list of Wlan / Device ids
- client_mac: values are a list of MAC addresses
- radius_group: this is a smart tag that matches RADIUS-Filter-ID, Airespace-ACL-Name (VendorID=14179, VendorType=6) / Aruba-User-Role (VendorID=14823, VendorType=1)
- radius_username: this matches the ATTR-User-Name(1)
- radius_class: the matches the ATTR-Class(25)
- radius_attr: the values are [ "6=1" , "26=10.2.3.4" ], this support other RADIUS attributes where we know the type
- radius_vendor: the values are [ "14179.10=1" , "14178.16=1.2.3.4" ], this matches vendor attributes and will be dynamically evaluated
If type==client, Client MAC address
Required if type==match; attribute compared against values. enum: ap_id, app, asset_mac, client_mac, hostname, ip_range_subnet, port, psk_name, psk_role, radius_attr, radius_class, radius_group, radius_username, sdkclient_uuid, wlan_id.
Value in
- "ap_id"
- "app"
- "asset_mac"
- "client_mac"
- "hostname"
- "ip_range_subnet"
- "port"
- "psk_name"
- "psk_role"
- "radius_attr"
- "radius_class"
- "radius_group"
- "radius_username"
- "sdkclient_uuid"
- "wlan_id"
Display name of the WxLAN tag
Required if type==match; whether values are inclusive or exclusive matches. enum: in, not_in.
"in"Value in
- "in"
- "not_in"
MAC address of the discovered resource associated with this tag, when applicable
Names of services associated with this WxLAN tag
Traffic match specifications used when type==spec
CIDR subnet associated with this WxLAN tag when type==subnet
Kind of WxLAN tag and how it is populated. enum: client, match, resource, spec, subnet, vlan.
Value in
- "client"
- "match"
- "resource"
- "spec"
- "subnet"
- "vlan"
Comparison values for the selected match attribute when type==match
Identifier of the VLAN associated with this WxLAN tag when type==vlan
Response Body
curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/wxtags" \ -H "Content-Type: application/json" \ -d '{ "match": "app", "name": "match app", "type": "match", "values": [ "gmail", "dropbox" ] }'{ "created_time": 0, "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "last_ips": [ "string" ], "mac": "string", "match": "wlan_id", "modified_time": 0, "name": "string", "op": "in", "org_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "resource_mac": "string", "services": [ "string" ], "site_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1", "specs": [ { "port_range": "string", "protocol": "tcp", "subnets": [ "string" ] } ], "subnet": "string", "type": "match", "values": [ "string" ]}