Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
API version v1 is deprecated
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
Resource URL
/webacs/api/v1/data/Clients
Deprecated
This version has been deprecated due to poor performance in large-scale environments. Please use v2.
Response Parameters
apMacAddress
String
|
Associated AP MAC address for wireless client
|
associationTime
long
|
Current or last session start time, measured in milliseconds since the Unix epoch.
|
clientInterface
String
|
Interface that the client is connected to
|
connectionType
ConnectionTypeEnum
|
Type of connection (Lightweight AP, Autonomous AP, or Wired)
|
deviceIpAddress
String
|
Associated device IP address
|
deviceName
String
|
|
deviceType
String
|
Device type of the client, like laptop, iPad, etc
|
hostname
String
|
DNS lookup by client IP address
|
ipAddress
String
|
|
location
String
|
Map location of the client
|
macAddress
String
|
|
protocol
ClientProtocolEnum
|
Client connection protocol (802.11a, 802.11ac, 802.11ax, 802.11b, 802.11g, 802.11n or 802.3)
|
securityPolicyStatus
SecurityPolicyStatusEnum
|
Status whether the client is on network (in running state)
|
ssid
String
|
SSID that the client is connected to
|
status
ClientStatusEnum
|
Current association status of the client
|
updateTime
long
|
Last time this record was updated, measured in milliseconds since the Unix epoch.
|
userName
String
|
|
vendor
String
|
Vendor name of the client card derived from OUI mapping.
Vendor names are updated when the client is first detected, and periodically as background jobs run (usually every 15 minutes). Disassociated clients will have vendor names updated until after they re-associate.
|
vlan
String
|
Name of the vlan that the client is connected to
|
vlanId
int
|
ID of the vlan the client is connected to
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://10.56.58.149/webacs/api/v1/data/Clients/15
<?xml version="1.0" ?>
<queryResponse type="Clients" responseType="getEntity" requestUrl="https://10.56.58.149/webacs/api/v1/data/Clients/15" rootUrl="https://10.56.58.149/webacs/api/v1/data">
<entity dtoType="clientsDTO" type="Clients" url="https://10.56.58.149/webacs/api/v1/data/Clients/15">
<clientsDTO displayName="String value" id="15" uuid="String value">
<associationTime>2</associationTime>
<clientInterface>String value</clientInterface>
<connectionType>LIGHTWEIGHTWIRELESS</connectionType>
<deviceName>String value</deviceName>
<deviceType>String value</deviceType>
<hostname>String value</hostname>
<location>String value</location>
<protocol>UNDEFINED</protocol>
<securityPolicyStatus>PASSED</securityPolicyStatus>
<ssid>String value</ssid>
<status>IDLE</status>
<updateTime>2</updateTime>
<userName>String value</userName>
<vendor>String value</vendor>
<vlan>String value</vlan>
<vlanId>1</vlanId>
<apMacAddress>String value</apMacAddress>
<deviceIpAddress>String value</deviceIpAddress>
<ipAddress>String value</ipAddress>
<macAddress>String value</macAddress>
</clientsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.56.58.149/webacs/api/v1/data/Clients/15.json
{
"queryResponse" : {
"@type" : "Clients",
"@responseType" : "getEntity",
"@requestUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/data\/Clients\/15",
"@rootUrl" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/data",
"entity" : {
"@dtoType" : "clientsDTO",
"@type" : "Clients",
"@url" : "https : \/\/10.56.58.149\/webacs\/api\/v1\/data\/Clients\/15",
"clientsDTO" : {
"@displayName" : "String value",
"@id" : "15",
"@uuid" : "String value",
"associationTime" : 2,
"clientInterface" : "String value",
"connectionType" : "LIGHTWEIGHTWIRELESS",
"deviceName" : "String value",
"deviceType" : "String value",
"hostname" : "String value",
"location" : "String value",
"protocol" : "UNDEFINED",
"securityPolicyStatus" : "PASSED",
"ssid" : "String value",
"status" : "IDLE",
"updateTime" : 2,
"userName" : "String value",
"vendor" : "String value",
"vlan" : "String value",
"vlanId" : 1,
"apMacAddress" : "String value",
"deviceIpAddress" : "String value",
"ipAddress" : "String value",
"macAddress" : "String value"
}
}
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v2/data/Clients
Updated
This resource has been updated since the previous API version. It may have changes that are not compatible with API clients written for previous API versions.
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
apMacAddress
String
|
Associated AP MAC address for wireless client
|
associationTime
long
|
Current or last session start time, measured in milliseconds since the Unix epoch.
|
clientInterface
String
|
Interface that the client is connected to
|
connectionType
ConnectionTypeEnum
|
Type of connection (Lightweight AP, Autonomous AP, or Wired)
|
deviceIpAddress
InetAddress
|
Associated device IP address
|
deviceName
String
|
|
deviceType
String
|
Device type of the client, like laptop, iPad, etc
|
hostname
String
|
DNS lookup by client IP address
|
ipAddress
InetAddress
|
|
location
String
|
Map location of the client
|
macAddress
String
|
|
protocol
ClientProtocolEnum
|
Client connection protocol (802.11a, 802.11ac, 802.11ax, 802.11b, 802.11g, 802.11n or 802.3)
|
securityPolicyStatus
SecurityPolicyStatusEnum
|
Status whether the client is on network (in running state)
|
ssid
String
|
SSID that the client is connected to
|
status
ClientStatusEnum
|
Current association status of the client
|
updateTime
long
|
Last time this record was updated, measured in milliseconds since the Unix epoch.
|
userName
String
|
|
vendor
String
|
Vendor name of the client card derived from OUI mapping.
Vendor names are updated when the client is first detected, and periodically as background jobs run (usually every 15 minutes). Disassociated clients will have vendor names updated until after they re-associate.
|
vlan
String
|
Name of the vlan that the client is connected to
|
vlanId
int
|
ID of the vlan the client is connected to
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://10.56.58.149/webacs/api/v2/data/Clients/15
<?xml version="1.0" ?>
<queryResponse type="Clients" responseType="getEntity" requestUrl="https://10.56.58.149/webacs/api/v2/data/Clients/15" rootUrl="https://10.56.58.149/webacs/api/v2/data">
<entity dtoType="clientsDTO" type="Clients" url="https://10.56.58.149/webacs/api/v2/data/Clients/15">
<clientsDTO displayName="String value" id="15" uuid="String value">
<associationTime>2</associationTime>
<clientInterface>String value</clientInterface>
<connectionType>LIGHTWEIGHTWIRELESS</connectionType>
<deviceName>String value</deviceName>
<deviceType>String value</deviceType>
<hostname>String value</hostname>
<location>String value</location>
<protocol>UNDEFINED</protocol>
<securityPolicyStatus>PASSED</securityPolicyStatus>
<ssid>String value</ssid>
<status>IDLE</status>
<updateTime>2</updateTime>
<userName>String value</userName>
<vendor>String value</vendor>
<vlan>String value</vlan>
<vlanId>1</vlanId>
<apMacAddress>String value</apMacAddress>
<deviceIpAddress>
<address>192.168.115.243</address>
</deviceIpAddress>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<macAddress>String value</macAddress>
</clientsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.56.58.149/webacs/api/v2/data/Clients/15.json
{
"queryResponse" : {
"@type" : "Clients",
"@requestUrl" : "https://10.56.58.149/webacs/api/v2/data/Clients/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.56.58.149/webacs/api/v2/data",
"entity" : [ {
"@dtoType" : "clientsDTO",
"@type" : "Clients",
"@url" : "https://10.56.58.149/webacs/api/v2/data/Clients/15",
"clientsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"apMacAddress" : "String value",
"associationTime" : 2,
"clientInterface" : "String value",
"connectionType" : "LIGHTWEIGHTWIRELESS",
"deviceIpAddress" : {
"address" : "192.168.115.243"
},
"deviceName" : "String value",
"deviceType" : "String value",
"hostname" : "String value",
"ipAddress" : {
"address" : "192.168.115.243"
},
"location" : "String value",
"macAddress" : "String value",
"protocol" : "UNDEFINED",
"securityPolicyStatus" : "PASSED",
"ssid" : "String value",
"status" : "IDLE",
"updateTime" : 2,
"userName" : "String value",
"vendor" : "String value",
"vlan" : "String value",
"vlanId" : 1
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v3/data/Clients
Unmodified
This resource has not been modified since the previous API version.
Deprecated
This version has been deprecated. Please use v4.
Response Parameters
apMacAddress
String
|
Associated AP MAC address for wireless client
|
associationTime
long
|
Current or last session start time, measured in milliseconds since the Unix epoch.
|
clientInterface
String
|
Interface that the client is connected to
|
connectionType
ConnectionTypeEnum
|
Type of connection (Lightweight AP, Autonomous AP, or Wired)
|
deviceIpAddress
InetAddress
|
Associated device IP address
|
deviceName
String
|
|
deviceType
String
|
Device type of the client, like laptop, iPad, etc
|
hostname
String
|
DNS lookup by client IP address
|
ipAddress
InetAddress
|
|
location
String
|
Map location of the client
|
macAddress
String
|
|
protocol
ClientProtocolEnum
|
Client connection protocol (802.11a, 802.11ac, 802.11ax, 802.11b, 802.11g, 802.11n or 802.3)
|
securityPolicyStatus
SecurityPolicyStatusEnum
|
Status whether the client is on network (in running state)
|
ssid
String
|
SSID that the client is connected to
|
status
ClientStatusEnum
|
Current association status of the client
|
updateTime
long
|
Last time this record was updated, measured in milliseconds since the Unix epoch.
|
userName
String
|
|
vendor
String
|
Vendor name of the client card derived from OUI mapping.
Vendor names are updated when the client is first detected, and periodically as background jobs run (usually every 15 minutes). Disassociated clients will have vendor names updated until after they re-associate.
|
vlan
String
|
Name of the vlan that the client is connected to
|
vlanId
int
|
ID of the vlan the client is connected to
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://10.56.58.149/webacs/api/v3/data/Clients/15
<?xml version="1.0" ?>
<queryResponse type="Clients" responseType="getEntity" requestUrl="https://10.56.58.149/webacs/api/v3/data/Clients/15" rootUrl="https://10.56.58.149/webacs/api/v3/data">
<entity dtoType="clientsDTO" type="Clients" url="https://10.56.58.149/webacs/api/v3/data/Clients/15">
<clientsDTO displayName="String value" id="15" uuid="String value">
<associationTime>2</associationTime>
<clientInterface>String value</clientInterface>
<connectionType>LIGHTWEIGHTWIRELESS</connectionType>
<deviceName>String value</deviceName>
<deviceType>String value</deviceType>
<hostname>String value</hostname>
<location>String value</location>
<protocol>UNDEFINED</protocol>
<securityPolicyStatus>PASSED</securityPolicyStatus>
<ssid>String value</ssid>
<status>IDLE</status>
<updateTime>2</updateTime>
<userName>String value</userName>
<vendor>String value</vendor>
<vlan>String value</vlan>
<vlanId>1</vlanId>
<apMacAddress>String value</apMacAddress>
<deviceIpAddress>
<address>192.168.115.243</address>
</deviceIpAddress>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<macAddress>String value</macAddress>
</clientsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.56.58.149/webacs/api/v3/data/Clients/15.json
{
"queryResponse" : {
"@type" : "Clients",
"@requestUrl" : "https://10.56.58.149/webacs/api/v3/data/Clients/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.56.58.149/webacs/api/v3/data",
"entity" : [ {
"@dtoType" : "clientsDTO",
"@type" : "Clients",
"@url" : "https://10.56.58.149/webacs/api/v3/data/Clients/15",
"clientsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"apMacAddress" : "String value",
"associationTime" : 2,
"clientInterface" : "String value",
"connectionType" : "LIGHTWEIGHTWIRELESS",
"deviceIpAddress" : {
"address" : "192.168.115.243"
},
"deviceName" : "String value",
"deviceType" : "String value",
"hostname" : "String value",
"ipAddress" : {
"address" : "192.168.115.243"
},
"location" : "String value",
"macAddress" : "String value",
"protocol" : "UNDEFINED",
"securityPolicyStatus" : "PASSED",
"ssid" : "String value",
"status" : "IDLE",
"updateTime" : 2,
"userName" : "String value",
"vendor" : "String value",
"vlan" : "String value",
"vlanId" : 1
}
} ]
}
}
Resource Information
Rate Limiting?
|
Yes
|
Sorting?
|
Yes
|
Paging?
|
Yes
|
Filtering?
|
Yes
|
Group Filtering?
|
No
|
Aggregation?
|
Yes
|
Response Formats
|
|
User Group
|
NBI Read
|
HTTP Methods
|
|
Resource URL
/webacs/api/v4/data/Clients
Updated
Since version 4 type of macAddress, apMacAddress attributes is MacAddress.
Response Parameters
apMacAddress
MacAddress
|
Associated AP MAC address for wireless client
|
associationTime
long
|
Current or last session start time, measured in milliseconds since the Unix epoch.
|
clientInterface
String
|
Interface that the client is connected to
|
connectionType
ConnectionTypeEnum
|
Type of connection (Lightweight AP, Autonomous AP, or Wired)
|
deviceIpAddress
InetAddress
|
Associated device IP address
|
deviceName
String
|
|
deviceType
String
|
Device type of the client, like laptop, iPad, etc
|
hostname
String
|
DNS lookup by client IP address
|
ipAddress
InetAddress
|
|
location
String
|
Map location of the client
|
macAddress
MacAddress
|
|
protocol
ClientProtocolEnum
|
Client connection protocol (802.11a, 802.11ac, 802.11ax, 802.11b, 802.11g, 802.11n or 802.3)
|
securityPolicyStatus
SecurityPolicyStatusEnum
|
Status whether the client is on network (in running state)
|
ssid
String
|
SSID that the client is connected to
|
status
ClientStatusEnum
|
Current association status of the client
|
updateTime
long
|
Last time this record was updated, measured in milliseconds since the Unix epoch.
|
userName
String
|
|
vendor
String
|
Vendor name of the client card derived from OUI mapping.
Vendor names are updated when the client is first detected, and periodically as background jobs run (usually every 15 minutes). Disassociated clients will have vendor names updated until after they re-associate.
|
vlan
String
|
Name of the vlan that the client is connected to
|
vlanId
int
|
ID of the vlan the client is connected to
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Payload
https://10.56.58.149/webacs/api/v4/data/Clients/15
<?xml version="1.0" ?>
<queryResponse type="Clients" responseType="getEntity" requestUrl="https://10.56.58.149/webacs/api/v4/data/Clients/15" rootUrl="https://10.56.58.149/webacs/api/v4/data">
<entity dtoType="clientsDTO" type="Clients" url="https://10.56.58.149/webacs/api/v4/data/Clients/15">
<clientsDTO displayName="String value" id="15" uuid="String value">
<associationTime>2</associationTime>
<clientInterface>String value</clientInterface>
<connectionType>LIGHTWEIGHTWIRELESS</connectionType>
<deviceName>String value</deviceName>
<deviceType>String value</deviceType>
<hostname>String value</hostname>
<location>String value</location>
<protocol>UNDEFINED</protocol>
<securityPolicyStatus>PASSED</securityPolicyStatus>
<ssid>String value</ssid>
<status>IDLE</status>
<updateTime>2</updateTime>
<userName>String value</userName>
<vendor>String value</vendor>
<vlan>String value</vlan>
<vlanId>1</vlanId>
<apMacAddress>
<octets>000a959d6816</octets>
</apMacAddress>
<deviceIpAddress>
<address>192.168.115.243</address>
</deviceIpAddress>
<ipAddress>
<address>192.168.115.243</address>
</ipAddress>
<macAddress>
<octets>000a959d6816</octets>
</macAddress>
</clientsDTO>
</entity>
</queryResponse>
Sample JSON Payload
https://10.56.58.149/webacs/api/v4/data/Clients/15.json
{
"queryResponse" : {
"@type" : "Clients",
"@requestUrl" : "https://10.56.58.149/webacs/api/v4/data/Clients/15",
"@responseType" : "getEntity",
"@rootUrl" : "https://10.56.58.149/webacs/api/v4/data",
"entity" : [ {
"@dtoType" : "clientsDTO",
"@type" : "Clients",
"@url" : "https://10.56.58.149/webacs/api/v4/data/Clients/15",
"clientsDTO" : {
"@displayName" : "String value",
"@id" : 15,
"@uuid" : "String value",
"apMacAddress" : {
"octets" : "000a959d6816"
},
"associationTime" : 2,
"clientInterface" : "String value",
"connectionType" : "LIGHTWEIGHTWIRELESS",
"deviceIpAddress" : {
"address" : "192.168.115.243"
},
"deviceName" : "String value",
"deviceType" : "String value",
"hostname" : "String value",
"ipAddress" : {
"address" : "192.168.115.243"
},
"location" : "String value",
"macAddress" : {
"octets" : "000a959d6816"
},
"protocol" : "UNDEFINED",
"securityPolicyStatus" : "PASSED",
"ssid" : "String value",
"status" : "IDLE",
"updateTime" : 2,
"userName" : "String value",
"vendor" : "String value",
"vlan" : "String value",
"vlanId" : 1
}
} ]
}
}