Overview
Input types are structured objects passed as arguments to queries. For example, MetricsFilterInput lets you specify a time range and aggregation interval when querying metrics.
Input type for specifying options when querying active clients metrics.
| Field | Type | Description |
|---|
includeMeterHardware | Boolean | Whether to include meter hardware in the metrics calculation. |
Input type for specifying filters when querying all client metrics timeseries data.
| Field | Type | Description |
|---|
timeFilter | MetricsFilterInput! | Specify the time range for the timeseries data. |
CaptivePortalEntryFilterInput
| Field | Type | Description |
|---|
ipAddress | IP | Filter captive portal entries by IP address. |
limit | Int! | The maximum number of captive portal entries to return. |
macAddress | MacAddress | Filter captive portal entries by MAC address. |
maxCreatedAt | DateTime | Only include captive portal entries that were created before or at this date and time. |
minCreatedAt | DateTime | Only include captive portal entries that were created at or after this date and time. |
offset | Int! | The number of captive portal entries to skip before starting to collect the result set. |
| Field | Type | Description |
|---|
timeFilter | MetricsFilterInput! | Specify the time range for the timeseries data. |
Input type for specifying filters when querying client metrics timeseries data.
| Field | Type | Description |
|---|
bands | [RadioBand!] | Specifying this field returns only metrics observed for the given radio band(s). |
channels | [Int!] | Specifying this field returns only metrics observed for the given radio channel(s). |
clientMacAddresses | [MacAddress!] | Filter events by client mac. |
eventTypes | [WirelessClientConnectionEventType!] | Filter events by event type(s). |
excludeObservers | Boolean | If true, exclude events from Observers. |
identity8021X | String | Filter events whose 802.1X identity contains the given string (case-insensitive). |
isNACEvent | Boolean | Filter events by whether they are NAC events. true returns only NAC events, false returns only non-NAC events, and omitting the field returns both. |
partialClientMacAddresses | [String!] | Filter events by partial client mac. |
reasonCodes | [Int!] | Filter events by 802.11 reason code(s). |
rssi | NumberRangeInput | Filter events by RSSI. |
ssidUUIDs | [UUID!] | Specifying this field returns only metrics observed for the given SSID(s), by UUID. |
timeFilter | MetricsFilterInput! | Specify the time range for the timeseries data. |
virtualDeviceUUIDs | [UUID!] | Filter events by virtual device. |
Filters the list of networks for a single company
| Field | Type | Description |
|---|
networkUUIDs | [UUID!] | Filter networks using their UUIDs. |
Input parameters for creating a Client VPN client.
| Field | Type | Description |
|---|
email | String! | End user's company email associated with the VPN server's controller. |
isEnabled | Boolean! | Whether the client is enabled. If false, users will not be able to connect using this client's key. |
name | String! | End user's device name, e.g., 'paulmbp'. |
publicKey | String! | A Curve25519 public key generated by the end user using WireGuard. |
| Field | Type | Description |
|---|
description | String | Description of the SSID. |
encryptionProtocol | SSIDEncryptionProtocol | Encryption protocol used by the SSID. |
isBand2GAllowed | Boolean! | Enable or disable broadcasting the SSID on the 2.4 GHz band. |
isBand5GAllowed | Boolean! | Enable or disable broadcasting the SSID on the 5 GHz band. |
isBand6GAllowed | Boolean! | Enable or disable broadcasting the SSID on the 6 GHz band. |
isEnabled | Boolean! | Enable or disable the SSID. |
isEnabledForAllAccessPoints | Boolean! | Enable the SSID for all access points or only specified ones. |
isGuest | Boolean! | Mark the SSID as a guest network. |
isHidden | Boolean! | Hide the SSID from being broadcasted. |
isIsolateClientsEnabled | Boolean! | Enable client isolation on the SSID. |
password | String | Pre-shared key (PSK) for the SSID. |
passwordRotationCadence | SSIDPasswordRotationCadence | Cadence for automatic password rotation. |
passwordRotationDayOfMonthLocal | Int | The day of the month for password rotation in the network's local time zone. |
passwordRotationDayOfWeekLocal | Int | The day of the week for password rotation in the network's local time zone (0 = Sunday). |
passwordRotationHourOfDayLocal | Int | The hour of the day for password rotation in the network's local time zone. |
ssid | String! | Name of the SSID. |
vlanUUID | UUID | UUID of the VLAN to associate with the SSID. |
| Field | Type | Description |
|---|
description | String | An optional description of the VLAN. |
ipV4ClientAssignmentProtocol | ClientAssignmentProtocol | Specifies the protocol for assigning IPv4 addresses to clients on this VLAN. |
ipV4ClientGateway | IPV4 | Specifies the IPv4 gateway address for this VLAN. |
ipV4ClientPrefixLength | Int | Specifies the IPv4 prefix length (subnet mask) for this VLAN. |
ipV6ClientAssignmentProtocol | ClientAssignmentProtocol | Specifies the protocol for assigning IPv6 addresses to clients on this VLAN. |
ipV6ClientGateway | IPV6 | Specifies the IPv6 gateway address for this VLAN. |
ipV6ClientPrefixLength | Int | Specifies the IPv6 prefix length (subnet mask) for this VLAN. |
isEnabled | Boolean! | If true, the VLAN is enabled upon creation. |
name | String! | A human-friendly name to identify the VLAN. |
vlanID | Int | The VLAN ID. Must be between 1 and 4094 and is unique per network. If not provided, the lowest available ID for the network will be selected. |
DevicesForNetworkFilter
Filter criteria for devices in a network.
| Field | Type | Description |
|---|
deviceType | VirtualDeviceType | Filter devices by virtual device type. |
deviceTypes | [VirtualDeviceType!] | Filter devices by any of the given device types. |
isDraft | Boolean | Filter devices by its draft state. |
HardwareDevicesFilter
Filters the response when fetching multiple hardware devices.
| Field | Type | Description |
|---|
deviceModel | DeviceModel | Filter hardware devices by device model. |
deviceType | DeviceType | Filter hardware devices by device type. |
limit | Int | The maximum number of hardware devices to return. Default is 200. |
offset | Int | The offset from where to start returning hardware devices. |
| Field | Type | Description |
|---|
SID | Int | Find events by signature ID. |
action | IDSEventAlertAction | Find events based on action. |
appProtocol | String | Find events based on application layer protocol. |
classType | String | Find rules by class type shortname. |
direction | IDSEventDirection | Find events based on direction. |
dstIP | IP | Find events based on destination IP. |
dstMAC | MacAddress | Find events based on destination MAC address. |
dstPort | PortRangeInput | Find events based on destination port. |
protocol | IDSEventProtocol | Find events based on protocol. |
search | IDSEventFilterSearchInput | Input for non-exact search against rule fields. |
srcIP | IP | Find events based on source IP. |
srcMAC | MacAddress | Find events based on source MAC address. |
srcPort | PortRangeInput | Find events based on source port. |
| Field | Type | Description |
|---|
description | String | An optional informational description for the suppression. |
A range of IP addresses.
| Field | Type | Description |
|---|
end | IP! | The upper address in the IP range. |
start | IP! | The lower address in the IP range. |
| Field | Type | Description |
|---|
durationSeconds | Int! | The total duration in seconds for which to retrieve metrics data. Maximum set to 1 year. |
endTime | DateTime | If not provided, endTime defaults to now. |
stepSeconds | Int! | The interval in seconds between data points in the metrics response. |
NetworkClientsFilter
| Field | Type | Description |
|---|
apSerialNumber | String | If provided, the latest connected clients for a network are returned that were reported to be connected to the given AP serial number. At most one of macAddress, apSerialNumber, vlanID, or ssid can be provided. |
excludeMeterHardware | Boolean! | If true, clients identified as Meter hardware devices will be excluded from the results. |
includeLatency | Boolean! | If provided, then the ping latency from controller to client is included in the response. |
includeThroughput | Boolean! | If provided, the average usage for all returned clients in the last 30 minutes will be included in the response. If macAddress is provided this field has no effect. |
ipRange | IPRangeInput | If provided, returns clients with IP addresses within the provided range. |
lookbackMinutes | Int! | When no macAddress and apSerialNumber are provided, filters resulting clients' lastSeen to this many minutes before now. |
macAddress | MacAddress | If a mac address is provided, this will get the history of clients with this mac address. At most one of macAddress, apSerialNumber, vlanID, or ssid can be provided. |
ssid | String | If provided, the latest connected clients for a network are returned that were reported to be connected to the given SSID. Only supported for config 2 COS networks. At most one of macAddress, apSerialNumber, vlanID, or ssid can be provided. |
timestamp | DateTime | If provided, then returns the results that were observed at the given timestamp. If null, defaults to now. |
vlanID | Int | If provided, the latest connected clients for a network are returned that were reported to be connected to the given VLAN. Only supported for config 2 COS networks. At most one of macAddress, apSerialNumber, vlanID, or ssid can be provided. |
A number range input type.
| Field | Type | Description |
|---|
max | Int | The maximum value |
min | Int | The minimum value |
Input type for specifying a port range.
| Field | Type | Description |
|---|
lower | Int! | Lower bound of the port range (1-65535). |
upper | Int! | Upper bound of the port range (1-65535). |
| Field | Type | Description |
|---|
isGuest | Boolean | The guest status to filter by. |
isHidden | Boolean | The hidden status to filter by. |
ssid | String | The SSID to filter by. |
| Field | Type | Description |
|---|
description | String | Description of the SSID. |
encryptionProtocol | SSIDEncryptionProtocol | Encryption protocol used by the SSID. |
isBand2GAllowed | Boolean | Enable or disable broadcasting the SSID on the 2.4 GHz band. |
isBand5GAllowed | Boolean | Enable or disable broadcasting the SSID on the 5 GHz band. |
isBand6GAllowed | Boolean | Enable or disable broadcasting the SSID on the 6 GHz band. |
isEnabled | Boolean | Enable or disable the SSID. |
isEnabledForAllAccessPoints | Boolean | Enable the SSID for all access points or only specified ones. |
isGuest | Boolean | Mark the SSID as a guest network. |
isHidden | Boolean | Hide the SSID from being broadcasted. |
isIsolateClientsEnabled | Boolean | Enable client isolation on the SSID. |
password | String | Pre-shared key (PSK) for the SSID. |
passwordRotationCadence | SSIDPasswordRotationCadence | Cadence for automatic password rotation. |
passwordRotationDayOfMonthLocal | Int | The day of the month for password rotation in the network's local time zone. |
passwordRotationDayOfWeekLocal | Int | The day of the week for password rotation in the network's local time zone (0 = Sunday). |
passwordRotationHourOfDayLocal | Int | The hour of the day for password rotation in the network's local time zone. |
ssid | String | Name of the SSID. |
vlanUUID | UUID | UUID of the VLAN to associate with the SSID. |
| Field | Type | Description |
|---|
description | String | A new description for the VLAN. |
ipV4ClientAssignmentProtocol | ClientAssignmentProtocol | Updates the protocol for assigning IPv4 addresses to clients on this VLAN. |
ipV4ClientGateway | IPV4 | Updates the IPv4 gateway address for this VLAN. |
ipV4ClientPrefixLength | Int | Updates the IPv4 prefix length (subnet mask) for this VLAN. |
ipV6ClientAssignmentProtocol | ClientAssignmentProtocol | Updates the protocol for assigning IPv6 addresses to clients on this VLAN. |
ipV6ClientGateway | IPV6 | Updates the IPv6 gateway address for this VLAN. |
ipV6ClientPrefixLength | Int | Updates the IPv6 prefix length (subnet mask) for this VLAN. |
isEnabled | Boolean | Enable or disable the VLAN. |
name | String | A new name for the VLAN. |
vlanID | Int | The new VLAN ID. Must be between 1 and 4094 and unique per network. |
Deprecated
The following are deprecated and may be removed in a future release. Use the suggested replacement and avoid them in new integrations.
Need help?
If you run into any issues or have questions, please reach out to our Support Engineering team by opening a ticket via the Dashboard: https://dashboard.meter.com/support