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 adding a network to an AutoVPN group.
| Field | Type | Description |
|---|
networkUUID | UUID! | Unique identifier of the network to add as a member. |
permittedVLANUUIDs | [UUID!] | List of permitted VLAN unique identifiers. The associated VLANs must have participatesInVPNs set to true. |
phyInterfaceUUID | UUID! | Unique identifier of the physical interface used by the member's uplink. |
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. |
BoolFilter
| Field | Type | Description |
|---|
key | String! | The key for the filter. |
value | Boolean! | Boolean value for the filter. |
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 address. |
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 address. |
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. |
| Field | Type | Description |
|---|
action | FirewallRuleAction! | The action to take when the rule is matched. |
applicationID | Int | The ID of the Netstar application to associate with the rule. |
boundDHCPRuleUUIDs | [UUID!]! | List of UUIDs of DHCP rules to which the application DNS firewall rule is bound. |
categoryID | Int | The ID of the Netstar category to associate with the rule. |
domain | String | The domain or FQDN that is matched by the rule, allowing for wildcards denoted by '*'. |
groupID | Int | The ID of the Netstar group to associate with the rule. |
isEnabled | Boolean! | Indicates whether the rule is enabled; defaults to true. |
name | String! | The name of the DNS firewall rule. |
priority | Int | The priority of the rule; if not provided, will default to 1 greater than the highest existing priority. |
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. |
Input type for creating a new firewall rule.
| Field | Type | Description |
|---|
action | FirewallRuleAction! | The action to take when the firewall rule matches (e.g., DENY or PERMIT). |
boundPhyInterfaceUUIDs | [UUID!]! | List of UUIDs of physical interfaces to which the firewall rule is bound. The physical interfaces must be uplinks. |
boundVLANUUIDs | [UUID!]! | List of UUIDs of VLANs to which the firewall rule is bound. |
description | String | A description of the firewall rule. |
dstPortRanges | [PortRangeInput!] | List of destination port ranges to match traffic to. |
dstPrefixes | [IPPrefix!] | Destination IP prefixes to match traffic to. |
dstVLANUUID | UUID | UUID of the destination VLAN to match traffic to. |
isEnabled | Boolean! | Indicates if the firewall rule is currently enabled. |
name | String! | The name of the firewall rule. |
priority | Int | Priority of the rule within the network, lower priority rules are applied first. If there is an existing rule with the provided value, it and all subsequent occupied values will be incremented. If omitted, next lowest priority in network will be used. |
protocols | [IPProtocol!] | List of IP protocols to match. |
srcPortRanges | [PortRangeInput!] | List of source port ranges to match traffic from. |
srcPrefixes | [IPPrefix!] | Source IP prefixes to match traffic from. |
tags | [String!] | List of tags associated with the firewall rule. |
| Field | Type | Description |
|---|
enabledVLANUUIDs | [UUID!]! | VLANs to enable IDS/IPS for. |
ipsRuleDuration | Duration | How long rules generated by IPS stay valid. |
isEastWestProtectionEnabled | Boolean! | If east-west protection is enabled. |
minIPSSeverity | Int | The IPS minimum severity to act on. |
minSeverity | Int! | The IDS minimum severity to act on. |
mode | IDSIPSMode! | The mode IDS/IPS should act in. |
safelist | [IPPrefix!] | List of subnets that should never be blocked. |
A custom intrusion rule definition for IDS/IPS. These currently apply tls.sni rules.
| Field | Type | Description |
|---|
action | FirewallRuleAction! | The action this rule applies. |
applicationID | Int | The ID of the Netstar application to associate with the rule. |
boundVLANUUIDs | [UUID!]! | List of UUIDs of VLANs to which the rule is bound. |
domain | String | The FQDN this rule applies to. |
isEnabled | Boolean! | If this rule is enabled. |
name | String! | A name to identify this rule. |
| 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. |
Represents the input for creating a support case comment
| Field | Type | Description |
|---|
attachmentKeys | [String!] | Keys of files (returned from createSupportCaseAttachmentUploadUrl) to attach to this comment. |
author | SupportCaseContactInput | The author of the comment. Defaults to the authenticated user or the Meter API key owner. |
body | String! | Comment body. |
externalID | String | Client-supplied external identifier for the comment. |
| 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. |
DateRangeFilter
Date range filter implementation.
| Field | Type | Description |
|---|
end | DateTime | End of date range for the filter. |
key | String! | The key for the filter. |
start | DateTime | Start of date range for the filter. |
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 their draft state. |
virtualDeviceUUIDs | [UUID!] | If provided, only return virtual devices with these UUIDs. An empty list returns no devices. |
Filter type shared across all queries.
Get support cases input
| Field | Type | Description |
|---|
companyUUID | UUID | Company UUID to get support cases for, required for the API. |
filters | [FilterInput!]! | Filters to apply when fetching the page. |
page | PageInput! | Page location to load from. |
sort | SortOrderInput | Sort by order for the support cases. |
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. |
HardwareDevicesForNetworkFilter
Filter criteria for devices in a network.
| Field | Type | Description |
|---|
deviceType | DeviceType | Filter devices by virtual device type. |
| 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 events by rule 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 | Match events whose rule description contains this substring. |
| Field | Type | Description |
|---|
categoryUUID | UUID! | Unique identifier of the IDS/IPS category. |
mode | IDSIPSMode! | The mode of this binding, whether it applies to IDS or IPS. |
| Field | Type | Description |
|---|
categoryUUID | UUID! | Unique identifier of the IDS category. |
description | String | An optional informational description for the suppression. |
direction | IDSIPSSuppressedRuleDirection | The traffic direction to consider when determining IP prefix application. Required if ipPrefixes is set. |
ipPrefixes | [IPPrefix!] | The IP prefixes that this suppression should apply to. If set, direction is required. |
mode | IDSIPSMode! | The mode of this suppression, whether it applies to IDS or IPS. |
| Field | Type | Description |
|---|
mode | IDSIPSMode! | The mode of this binding, whether it applies to IDS or IPS. |
ruleSID | Int! | Unique signature ID of the IDS rule. |
| Field | Type | Description |
|---|
description | String | An optional informational description for the suppression. |
direction | IDSIPSSuppressedRuleDirection | The traffic direction to consider when determining IP prefix application. Required if ipPrefixes is set. |
ipPrefixes | [IPPrefix!] | The IP prefixes that this suppression should apply to. If set, direction is required. |
mode | IDSIPSMode! | The mode of this suppression, whether it applies to IDS or IPS. |
ruleSID | Int! | Unique signature ID of the IDS rule. |
| Field | Type | Description |
|---|
SID | Int | Find rules by signature ID. |
action | String | Find based on action for this rule. |
classType | String | Find rules by class type shortname. |
groupID | Int | Find rules by group ID. |
revision | Int | Find rules by revision. |
search | IDSRuleFilterSearchInput | Input for non-exact search against rule fields. |
Filter IDS rules based on substring search.
| Field | Type | Description |
|---|
description | String | Search based on description for this rule. |
header | String | Search based on header for this rule. |
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. |
MultiSelectFilter
Multiselect filter implementation.
| Field | Type | Description |
|---|
key | String! | The key for the filter. |
values | [String!]! | Selected values for the filter. |
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 on networks running a firewall. 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 on networks running a firewall. At most one of macAddress, apSerialNumber, vlanID, or ssid can be provided. |
NumberFilter
Number filter implementation.
| Field | Type | Description |
|---|
key | String! | The key for the filter. |
value | Float! | Number value for the filter. |
NumberRangeFilter
Number range filter implementation.
| Field | Type | Description |
|---|
end | Float | End of number range for the filter. |
key | String! | The key for the filter. |
start | Float | Start of number range for the filter. |
A number range input type.
| Field | Type | Description |
|---|
max | Int | The maximum value |
min | Int | The minimum value |
PageInput
Pagination input shared across all paginated queries.
| Field | Type | Description |
|---|
asOf | DateTime | Time pagination began |
limit | Int! | Max items to return (server may cap). |
page | Int | Page to jump to. |
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. |
SelectFilter
Select filter implementation.
| Field | Type | Description |
|---|
key | String! | The key for the filter. |
value | String! | Selected value for the filter. |
Sort order to apply to a list of results.
| Field | Type | Description |
|---|
fieldName | String! | Field to sort by. |
order | SortOrder! | Order of the sort. |
Input for getting or creating a support case contact by email.
| Field | Type | Description |
|---|
email | String! | Email of the contact. The contact is created if none with this email exists. |
name | String | Name of the contact. |
phoneNumber | String | Phone number of the contact. |
title | String | Title of the contact. |
TextFilter
Text filter implementation.
| Field | Type | Description |
|---|
key | String! | The key for the filter. |
value | String! | Text value for the filter. |
| Field | Type | Description |
|---|
action | FirewallRuleAction | The action to take when the rule is matched. |
applicationID | Int | The ID of the Netstar application to associate with the rule. |
boundDHCPRuleUUIDs | [UUID!] | List of UUIDs of DHCP rules to which the application DNS firewall rule is bound. |
categoryID | Int | The ID of the Netstar category to associate with the rule. |
domain | String | The domain or FQDN that is matched by the rule, allowing for wildcards denoted by '*'. |
groupID | Int | The ID of the Netstar group to associate with the rule. |
isEnabled | Boolean | Indicates whether the rule is enabled. |
name | String | The name of the DNS firewall rule. |
priority | Int | The priority of the rule; if not specified, will default to 1 greater than the highest existing priority. |
Updates an existing AutoVPN member.
| Field | Type | Description |
|---|
permittedVLANUUIDs | [UUID!] | List of permitted VLAN unique identifiers. The associated VLANs must have participatesInVPNs set to true. |
Input type for updating an existing firewall rule.
| Field | Type | Description |
|---|
action | FirewallRuleAction | The action to take when the firewall rule matches (e.g., DENY or PERMIT). |
boundPhyInterfaceUUIDs | [UUID!] | List of UUIDs of physical interfaces to which the firewall rule is bound. The physical interfaces must be uplinks. |
boundVLANUUIDs | [UUID!] | List of UUIDs of VLANs to which the firewall rule is bound. |
description | String | A description of the firewall rule. |
dstPortRanges | [PortRangeInput!] | List of destination port ranges to match traffic to. |
dstPrefixes | [IPPrefix!] | Destination IP prefixes to match traffic to. |
dstVLANUUID | UUID | UUID of the destination VLAN to match traffic to. |
isEnabled | Boolean | Indicates if the firewall rule is currently enabled. |
name | String | The name of the firewall rule. |
priority | Int | Priority of the rule within the network, lower priority rules are applied first. If there is an existing rule with the provided value, it and all subsequent occupied values will be incremented. |
protocols | [IPProtocol!] | List of IP protocols to match. |
srcPortRanges | [PortRangeInput!] | List of source port ranges to match traffic from. |
srcPrefixes | [IPPrefix!] | Source IP prefixes to match traffic from. |
tags | [String!] | List of tags associated with the firewall rule. |
A custom intrusion rule definition for IDS/IPS. These currently apply tls.sni rules.
| Field | Type | Description |
|---|
action | FirewallRuleAction | The action this rule applies. |
applicationID | Int | The ID of the Netstar application to associate with the rule. |
boundVLANUUIDs | [UUID!] | List of UUIDs of VLANs to which the rule is bound. |
domain | String | The FQDN this rule applies to. |
isEnabled | Boolean | If this rule is enabled. |
name | String | A name to identify this rule. |
Input type for updating an outlet interface.
| Field | Type | Description |
|---|
isEnabled | Boolean | Whether or not the outlet interface is enabled. |
| 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. |
Represents the input for updating support cases
| 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