eero API Route Catalog

Select an eero Executor alias for account, network, device, or usage reads. Includes exact GET routes and plain input rules for all 72 aliases.

The eero cloud API gives access to account, network, device, and usage information. The Executor integration lets an agent or tool read this information through a connected eero account.

Use it to build an account and network inventory, identify devices and eero nodes, inspect current settings, or read historical usage. Choose the account and network before you request information about a device, profile, or node.

How requests work

An agent or tool calls an eero alias, the operation name in Executor. The adapter is the code that checks the input and sends the request. It adds saved account authentication and sends an HTTPS request to api-user.e2ro.com. It checks the response, filters credential fields, and returns the result to the caller.

Before you start

You need an eero account with permission to read the target resources and valid authentication. An existing network is required for requests that select a network. For Executor calls, use a connected account profile: the saved connection that selects account access. Its session credential is the token that authorizes requests. Keep it in the secure account connection.

For direct API calls, use an HTTPS client and a valid session token for the account. Follow the linked authentication and request instructions. Do not put credentials in tool inputs, documentation examples, or logs.

Start with account.get_account and networks.get_networks, using {} for each input. Check the account. For a network request, select a network from the list. Then call networks.get_network with its identifier, the value that selects that network, under path.network_id. Use identifiers from the selected network for later device, profile, and node calls.

Access to some resources depends on account permission, subscription, or device support. A listed operation does not give the caller access to that resource.

This catalog maps 72 Executor aliases to 66 GET routes in 31 groups. Use the operation sections to select an alias and supply its inputs.

Search routes and operation groups in the interactive API reference.

Read the authentication, request, and error instructions.

Resources and identifiers

An identifier is the value that selects a resource. Use values from the account you selected. List networks with networks.get_networks. Then use the selected network with devices.get_devices, eeros.get_eeros, profiles.get_profiles, or subnets.get_config to find device, node, profile, or subnet identifiers. Do not assume a display name is an identifier.

An eero node is one eero unit in the network. An eero device profile groups devices in that network, for example for a family member. An Executor connection profile selects saved account access. These two profile types have different purposes.

A MAC address (Media Access Control address) identifies a network interface. The mac and device_mac inputs select a device with this address. A subnet is a division of an IP network with its own address range.

Reporting periods

start and end select the requested reporting period. cadence selects daily or hourly intervals. timezone supplies the reporting time zone when the operation accepts it. The examples show date-time strings, but the adapter checks text length only. It does not check date formats, zone names, time order, or whether the period includes its boundary times. The source does not establish server defaults or available history.

Terms used in this reference

• DNS (Domain Name System) maps names to network addresses. SMS (Short Message Service) sends text messages. LED means a light indicator on a node. A feature entitlement is the account or network right to use a feature.
• AC compatibility is the name used for these eero Wi-Fi compatibility settings. The source does not explain what AC means or how the mode works. OUI (Organizationally Unique Identifier) is the organization prefix in a MAC address; it does not prove device type or ownership.
• SQM (Smart Queue Management) controls queues of network traffic to reduce delay. Fast transition supports Wi-Fi client roaming between access points. WPA3 (Wi-Fi Protected Access 3) is a Wi-Fi security standard. These read routes do not change the settings.
• Thread is a low-power mesh networking protocol used by connected devices. Insights are eero analysis results for the requested network, devices, or profiles. This source does not define each insight category.
• HTTP is the request and response protocol used by this API. HTTPS encrypts that traffic. GET is the HTTP method used to request a read. Headers carry request information such as authentication. Query fields carry operation inputs after ? in the URL.
• JSON is the structured text format used for inputs and responses. An integer is a whole number. null means that no data value is present. The HTTP status is the server response code; meta.code is the code inside the eero JSON response. Executor checks these codes as described in Response handling and Errors. REST describes APIs that use resource URLs and HTTP methods. OAuth 2.0 is an authorization protocol that lets a customer grant an application access; it applies to the separate Data Portability API described at the end of the article.
• Upstream means the eero server that Executor calls. A redirect asks the client to use another URL; the adapter refuses it. UTF-8 is the text encoding used to read responses. KiB means 1024 bytes; MiB means 1,048,576 bytes.

Shared GET input rules

All operations below use GET. They accept no request body and add no Content-Type header. Put required route values under path and listed query fields under query. Omit locations that the alias does not accept. Use {} when it has no inputs.

Supply path values without percent encoding. The adapter applies encodeURIComponent to each value and uses URLSearchParams for query values. It rejects extra fields at every input level.

The field rules below describe Executor input validation. They do not define additional eero server requirements. Text fields accept 1 to 1024 characters. Identifier fields accept 1 to 128 characters with the ASCII rules stated in each field. The adapter does not check date formats, time zones, or chronological order in text fields.

Supply numeric query values and true/false query choices as strings when listed. Do not replace them with JSON numbers or booleans.

Aliases that share a route return the same record after adapter filtering. The network settings aliases return the network record. The LED alias returns the node record. The profile devices alias returns the profile record.

Alias groups

• ac_compat: 1 alias.
• account: 2 aliases.
• backup: 3 aliases.
• backup_access_points: 2 aliases.
• blacklist: 1 alias.
• data_usage: 11 aliases.
• devices: 3 aliases.
• diagnostics: 1 alias.
• dns: 1 alias.
• dns_policies: 2 aliases.
• eeros: 4 aliases.
• entitlements: 4 aliases.
• events: 3 aliases.
• forwards: 1 alias.
• insights: 6 aliases.
• members: 2 aliases.
• networks: 5 aliases.
• notifications: 3 aliases.
• ouicheck: 1 alias.
• permissions: 1 alias.
• power_saving: 1 alias.
• profiles: 3 aliases.
• reservations: 1 alias.
• routing: 1 alias.
• security: 2 aliases.
• sqm: 1 alias.
• subnets: 2 aliases.
• support: 1 alias.
• thread: 1 alias.
• updates: 1 alias.
• wpa3: 1 alias.

Wi-Fi AC compatibility

Read AC compatibility settings

ac_compat.get_ac_compat

GET /2.2/networks/{network_id}/ac_compat

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Account

Read the account

account.get_account

GET /2.2/account

No query fields are accepted.

Executor input: {}.

List SMS countries

account.get_sms_countries

GET /2.2/countries/sms

No query fields are accepted.

Executor input: {}.

Backup

Read backup internet settings

backup.get_backup_internet

GET /2.2/networks/{network_id}/backupinternet

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read cellular backup usage

backup.get_cellular_backup_usage

GET /2.2/networks/{network_id}/cellular_backup_usage

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read cellular backup events

backup.get_cellular_backup_events

GET /2.2/networks/{network_id}/cellular_backup_events

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Backup access points

List backup access points

backup_access_points.list

GET /2.2/networks/{network_id}/backup_access_points

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read backup Wi-Fi discovery status

backup_access_points.discover_ssids

GET /2.2/networks/{network_id}/backup_access_points/ssid_discovery

This request reads discovery status. It does not start Wi-Fi discovery.

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Blacklist

Read the device block list

blacklist.get_blacklist

GET /2.2/networks/{network_id}/blacklist

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Data usage

Read network data usage

data_usage.get_data_usage

GET /2.2/networks/{network_id}/data_usage

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Required. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.timezone

Optional. Supply a time-zone value for the reporting period. The source does not establish accepted zone names or a server default.

Input rule: String, 1 to 1024 characters.

The query object is required.

Read the data usage breakdown

data_usage.get_breakdown

GET /2.2/networks/{network_id}/data_usage/breakdown

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Optional. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.timezone

Optional. Supply a time-zone value for the reporting period. The source does not establish accepted zone names or a server default.

Input rule: String, 1 to 1024 characters.

The query object is required.

Read data usage for devices

data_usage.get_devices_usage

GET /2.2/networks/{network_id}/data_usage/devices

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Optional. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.timezone

Optional. Supply a time-zone value for the reporting period. The source does not establish accepted zone names or a server default.

Input rule: String, 1 to 1024 characters.

query.profile_id

Optional. Select an eero device profile for the usage request. Get its identifier with profiles.get_profiles.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

The query object is required.

Read data usage for one device

data_usage.get_device_usage

GET /2.2/networks/{network_id}/data_usage/devices/{device_mac}

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

path.device_mac

Required. Select a device by its MAC address. Get the address with devices.get_devices for the selected network.

Input rule: String with six hexadecimal pairs separated by colons. Example: 02:00:00:00:00:01.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Required. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.timezone

Optional. Supply a time-zone value for the reporting period. The source does not establish accepted zone names or a server default.

Input rule: String, 1 to 1024 characters.

The query object is required.

Read data usage for eero nodes

data_usage.get_eeros_usage

GET /2.2/networks/{network_id}/data_usage/eeros

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Required. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.timezone

Optional. Supply a time-zone value for the reporting period. The source does not establish accepted zone names or a server default.

Input rule: String, 1 to 1024 characters.

The query object is required.

Read the eero node usage summary

data_usage.get_eeros_summary

GET /2.2/networks/{network_id}/data_usage/eeros/summary

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Required. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.timezone

Optional. Supply a time-zone value for the reporting period. The source does not establish accepted zone names or a server default.

Input rule: String, 1 to 1024 characters.

The query object is required.

Read data usage for one eero node

data_usage.get_eero_usage

GET /2.2/networks/{network_id}/data_usage/eeros/{eero_id}

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

path.eero_id

Required. Select an eero node. Get its identifier with eeros.get_eeros for the selected network.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Required. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.timezone

Optional. Supply a time-zone value for the reporting period. The source does not establish accepted zone names or a server default.

Input rule: String, 1 to 1024 characters.

The query object is required.

Read data usage for one profile

data_usage.get_profile_usage

GET /2.2/networks/{network_id}/data_usage/profiles/{profile_id}

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

path.profile_id

Required. Select an eero device profile. Get its identifier with profiles.get_profiles for the selected network.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Required. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.timezone

Optional. Supply a time-zone value for the reporting period. The source does not establish accepted zone names or a server default.

Input rule: String, 1 to 1024 characters.

The query object is required.

Read usage for devices without a profile

data_usage.get_unprofiled_devices

GET /2.2/networks/{network_id}/data_usage/unprofiled/devices

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Optional. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.timezone

Optional. Supply a time-zone value for the reporting period. The source does not establish accepted zone names or a server default.

Input rule: String, 1 to 1024 characters.

The query object is required.

Read the usage summary for devices without a profile

data_usage.get_unprofiled_summary

GET /2.2/networks/{network_id}/data_usage/unprofiled/summary

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Required. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.timezone

Optional. Supply a time-zone value for the reporting period. The source does not establish accepted zone names or a server default.

Input rule: String, 1 to 1024 characters.

The query object is required.

Read data usage report settings

data_usage.get_report_settings

GET /2.2/networks/{network_id}/data_usage/report_settings

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Devices

List network devices

devices.get_devices

GET /2.2/networks/{network_id}/devices

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.thread

Optional. Supply the Thread option for the device list. The source does not establish which devices each value includes or the server default.

Input rule: String. Use "true", "false".

query.proxied_node

Optional. Supply the proxied-node option for the device list. The source does not establish its selection behavior or the server default.

Input rule: String. Use "true", "false".

The query object is optional. Omit it when no query fields are needed.

Read one network device

devices.get_device

GET /2.2/networks/{network_id}/devices/{mac}

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

path.mac

Required. Select a device by its MAC address. Get the address with devices.get_devices for the selected network.

Input rule: String with six hexadecimal pairs separated by colons. Example: 02:00:00:00:00:01.

No query fields are accepted.

Read device labels

devices.get_device_labels

GET /2.2/networks/{network_id}/devices/{mac}/labels

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

path.mac

Required. Select a device by its MAC address. Get the address with devices.get_devices for the selected network.

Input rule: String with six hexadecimal pairs separated by colons. Example: 02:00:00:00:00:01.

No query fields are accepted.

Diagnostics

Read network diagnostics

diagnostics.get_diagnostics

GET /2.2/networks/{network_id}/diagnostics

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

DNS settings

Read the network record for DNS settings

dns.get_dns_settings

GET /2.2/networks/{network_id}

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

DNS content policies

Read advanced content filter settings

dns_policies.get_advanced_content_filter

GET /2.2/networks/{network_id}/dns_policies/advanced_content_filter

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read profile application policies

dns_policies.get_profile_applications

GET /2.2/networks/{network_id}/dns_policies/profiles/{profile_id}/applications

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

path.profile_id

Required. Select an eero device profile. Get its identifier with profiles.get_profiles for the selected network.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Eero nodes

List eero nodes

eeros.get_eeros

GET /2.2/networks/{network_id}/eeros

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read one eero node

eeros.get_eero

GET /2.2/eeros/{eero_id}

path.eero_id

Required. Select an eero node. Get its identifier with eeros.get_eeros for the selected network.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read the eero node record for LED status

eeros.get_led_status

GET /2.2/eeros/{eero_id}

path.eero_id

Required. Select an eero node. Get its identifier with eeros.get_eeros for the selected network.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read eero node connections

eeros.get_connections

GET /2.2/eeros/{eero_id}/connections

path.eero_id

Required. Select an eero node. Get its identifier with eeros.get_eeros for the selected network.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Entitlements

Read network feature entitlements

entitlements.get_features

GET /2.2/entitlements/networks/{network_id}/features

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read additional network feature offers

entitlements.get_upsell_features

GET /2.2/entitlements/networks/{network_id}/upsell_features

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read eero model capabilities

entitlements.get_model_capabilities

GET /2.2/eero_models/capabilities

query.networkId

Required. Select the network for the model capability request. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

The query object is required.

Read premium customer information

entitlements.get_premium_customer

GET /2.2/premium/customer

No query fields are accepted.

Executor input: {}.

Events

Read application events

events.get_app_events

GET /2.2/networks/{network_id}/app_events

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.page_size

Optional. Supply the application event page size. The source does not establish the server default or the meaning of zero.

Input rule: String with 1 to 12 digits, 0 through 9. Zero and leading zeros are accepted.

query.timestamp

Optional. Supply the time value for the event or notification history request. The source does not establish its format, unit, or pagination boundary behavior.

Input rule: String, 1 to 1024 characters.

The query object is optional. Omit it when no query fields are needed.

Read Wi-Fi channel use

events.get_channel_utilization

GET /2.2/networks/{network_id}/channel_utilization

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.busy_threshold

Optional. Supply the channel-use busy threshold. The source does not establish its unit, comparison behavior, or server default.

Input rule: String with 1 to 12 digits. The first digit must be 1 through 9. Zero and leading zeros are not accepted.

query.eero_id

Optional. Supply the numeric node selector for channel use. This query value uses digits; path.eero_id uses a different identifier rule. The source does not establish how to map between them.

Input rule: String with 1 to 12 digits, 0 through 9. Zero and leading zeros are accepted.

query.band

Optional. Select the Wi-Fi frequency band. The listed choices distinguish 2.4 GHz, full/high/low 5 GHz, and 6 GHz. The source does not establish the high/low split or server default.

Input rule: String. Use "band_2_4GHz", "band_5GHz_full", "band_5GHz_high", "band_5GHz_low", "band_6GHz".

query.granularity

Optional. Supply the channel-use granularity value. The source does not establish the interval unit or server default.

Input rule: String with 1 to 12 digits. The first digit must be 1 through 9. Zero and leading zeros are not accepted.

query.gap_data_placeholder

Optional. Supply the channel-use gap placeholder option. The source does not establish how each value represents missing data or the server default.

Input rule: String with 1 to 12 digits, 0 through 9. Zero and leading zeros are accepted.

The query object is required.

Read network scan results

events.get_network_scan

GET /2.2/networks/{network_id}/network_scan

This request reads scan results. It does not start a network scan.

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Forwards

Read port forwarding rules

forwards.get_forwards

GET /2.2/networks/{network_id}/forwards

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Insights

Read insights for one device

insights.get_device_insights

GET /2.2/networks/{network_id}/insights/devices/{mac}

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

path.mac

Required. Select a device by its MAC address. Get the address with devices.get_devices for the selected network.

Input rule: String with six hexadecimal pairs separated by colons. Example: 02:00:00:00:00:01.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Required. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.insight_type

Required. Select the requested insight category. The source does not establish the accepted vendor categories; do not guess them.

Input rule: String, 1 to 1024 characters.

The query object is required.

Read insights for devices

insights.get_devices_insights

GET /2.2/networks/{network_id}/insights/devices

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Required. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.insight_type

Required. Select the requested insight category. The source does not establish the accepted vendor categories; do not guess them.

Input rule: String, 1 to 1024 characters.

The query object is required.

Read network insights

insights.get_insights

GET /2.2/networks/{network_id}/insights

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Required. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.insight_type

Required. Select the requested insight category. The source does not establish the accepted vendor categories; do not guess them.

Input rule: String, 1 to 1024 characters.

The query object is required.

Read device insights for one profile

insights.get_profile_devices_insights

GET /2.2/networks/{network_id}/insights/profiles/{profile}/devices

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

path.profile

Required. Select an eero device profile. Get its identifier with profiles.get_profiles for the selected network.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Required. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.insight_type

Required. Select the requested insight category. The source does not establish the accepted vendor categories; do not guess them.

Input rule: String, 1 to 1024 characters.

The query object is required.

Read insights for one profile

insights.get_profile_insights

GET /2.2/networks/{network_id}/insights/profiles/{profile}

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

path.profile

Required. Select an eero device profile. Get its identifier with profiles.get_profiles for the selected network.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Required. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.insight_type

Required. Select the requested insight category. The source does not establish the accepted vendor categories; do not guess them.

Input rule: String, 1 to 1024 characters.

The query object is required.

Read insights for profiles

insights.get_profiles_insights

GET /2.2/networks/{network_id}/insights/profiles

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.start

Required. Set the start of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.end

Required. Set the end of the requested reporting period. See Reporting periods before the operation sections.

Input rule: String, 1 to 1024 characters.

query.cadence

Required. Select daily or hourly reporting intervals. See Reporting periods before the operation sections.

Input rule: String. Use "daily", "hourly".

query.insight_type

Required. Select the requested insight category. The source does not establish the accepted vendor categories; do not guess them.

Input rule: String, 1 to 1024 characters.

The query object is required.

Members

List network members

members.get_members

GET /2.2/networks/{network_id}/members

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

List network invitations

members.get_invites

GET /2.2/networks/{network_id}/invites

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Networks

List account networks

networks.get_networks

GET /2.2/networks

No query fields are accepted.

Executor input: {}.

Read one network

networks.get_network

GET /2.2/networks/{network_id}

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read the network record for premium status

networks.get_premium_status

GET /2.2/networks/{network_id}

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read speed test results

networks.get_speed_tests

GET /2.2/networks/{network_id}/speedtest

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.limit

Optional. Supply the speed test result limit. The source does not establish the server default or the meaning of zero.

Input rule: String with 1 to 12 digits, 0 through 9. Zero and leading zeros are accepted.

query.startTime

Optional. Set the start time for the speed test results request. The adapter does not check the time format or boundary rules.

Input rule: String, 1 to 1024 characters.

query.endTime

Optional. Set the end time for the speed test results request. The adapter does not check the time format or boundary rules.

Input rule: String, 1 to 1024 characters.

The query object is optional. Omit it when no query fields are needed.

Read guest network settings

networks.get_guest_network

GET /2.2/networks/{network_id}/guestnetwork

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Notifications

Read notification settings

notifications.get_settings

GET /2.2/networks/{network_id}/notifications

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read unread notification status

notifications.has_unread

GET /2.2/networks/{network_id}/notifications/has_unread

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read notification history

notifications.get_history

GET /2.2/networks/{network_id}/notifications_history

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.timestamp

Optional. Supply the time value for the event or notification history request. The source does not establish its format, unit, or pagination boundary behavior.

Input rule: String, 1 to 1024 characters.

The query object is optional. Omit it when no query fields are needed.

OUI organization prefix checks

Read OUI check information

ouicheck.get_ouicheck

GET /2.2/networks/{network_id}/ouicheck

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

query.serial

Required. Supply the serial value for the OUI check. The source does not establish which resource serial is required or a list call that supplies it.

Input rule: String, 1 to 1024 characters.

query.version

Required. Supply the version value for the OUI check. The source does not establish which component version is required or a list call that supplies it.

Input rule: String, 1 to 1024 characters.

The query object is required.

Permissions

Read network permissions

permissions.get_permissions

GET /2.2/networks/{network_id}/permissions

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Power saving

Read power saving schedules

power_saving.get_schedules

GET /2.2/networks/{network_id}/power_saving/schedules

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Eero device profiles

List network profiles

profiles.get_profiles

GET /2.2/networks/{network_id}/profiles

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read one profile

profiles.get_profile

GET /2.2/networks/{network_id}/profiles/{profile_id}

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

path.profile_id

Required. Select an eero device profile. Get its identifier with profiles.get_profiles for the selected network.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read the profile record for its devices

profiles.get_profile_devices

GET /2.2/networks/{network_id}/profiles/{profile_id}

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

path.profile_id

Required. Select an eero device profile. Get its identifier with profiles.get_profiles for the selected network.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Reservations

Read address reservations

reservations.get_reservations

GET /2.2/networks/{network_id}/reservations

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Routing

Read network routing settings

routing.get_routing

GET /2.2/networks/{network_id}/routing

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Security

Read the network record for security settings

security.get_security_settings

GET /2.2/networks/{network_id}

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read fast transition settings

security.get_fast_transition

GET /2.2/networks/{network_id}/fast_transition

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Smart Queue Management (SQM)

Read the network record for queue management settings

sqm.get_sqm_settings

GET /2.2/networks/{network_id}

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Subnets

Read subnet settings

subnets.get_config

GET /2.2/networks/{network_id}/subnets_config

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Read subnet content filters

subnets.get_content_filters

GET /2.2/networks/{network_id}/subnets_config/{subnet_id}/dns_policies/content_filters

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

path.subnet_id

Required. Select a subnet. Get its identifier from subnets.get_config for the selected network.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Support

Read network support information

support.get_support

GET /2.2/networks/{network_id}/support

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Thread

Read Thread settings and status

thread.get_thread

GET /2.2/networks/{network_id}/thread

Executor returns only allowed Thread status or invitation information. It omits credential fields, unknown fields, and unrecognized response representations.

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Updates

Read network update information

updates.get_updates

GET /2.2/networks/{network_id}/updates

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.

Wi-Fi security (WPA3)

Read WPA3 settings for each band

wpa3.get_wpa3_per_band

GET /2.2/networks/{network_id}/wpa3_per_band

path.network_id

Required. Select the network. Get its identifier with networks.get_networks.

Input rule: String, 1 to 128 characters. Start with an ASCII letter or digit. Then use only ASCII letters, digits, underscores, or hyphens.

No query fields are accepted.