Wireless

Assign AP port profile to list of APs.

API documentation: assignNetworkWirelessEthernetPortsProfiles

Parameters:

• network_id (str) –

  Network ID.

• serials (list[str]) –

  List of AP serials.

• profile_id (str) –

  AP profile ID.

Returns:

• AssignNetworkWirelessEthernetPortsProfilesResponse –

  Successful operation.

{
  "serials": [
    "Q234-ABCD-0001",
    "Q234-ABCD-0002",
    "Q234-ABCD-0003"
  ],
  "profileId": "1001"
}

Enqueue a job to start enrolling door locks on zigbee configured wireless devices.

API documentation: createDeviceWirelessZigbeeEnrollment

Parameters:

• serial (str) –

  Serial.

Returns:

• CreateDeviceWirelessZigbeeEnrollmentResponse –

  Successful operation.

{
  "enrollmentId": "1234",
  "url": "/devices/SERIAL/wireless/zigbee/enrollments/1234",
  "request": {
    "serial": "Q234-ABCD-5678"
  },
  "status": "complete"
}

Creates a new rule.

API documentation: createNetworkWirelessAirMarshalRule

Parameters:

• network_id (str) –

  Network ID.

• type_ (CreateNetworkWirelessAirMarshalRuleType) –

  Indicates if this rule will allow, block, or alert.

• match (CreateNetworkWirelessAirMarshalRuleMatch) –

  Object describing the rule specification.

Returns:

• NetworkWirelessAirMarshalRuleResponse –

  Successful operation.

{
  "network": {
    "id": "N_12345",
    "name": "Network 1"
  },
  "ruleId": "5239",
  "type": "allow",
  "updatedAt": "2023-05-23 12:02:46.298",
  "createdAt": "2023-05-23 12:02:46.298",
  "match": {
    "string": "ipsum",
    "type": "contains"
  }
}

Create an AP port profile.

API documentation: createNetworkWirelessEthernetPortsProfile

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  AP port profile name.

• ports (list[CreateNetworkWirelessEthernetPortsProfilePortsItem]) –

  AP ports configuration.

• usb_ports (list[CreateNetworkWirelessEthernetPortsProfileUsbPortsItem] | None, default: None ) –

  AP usb ports configuration.

Returns:

• NetworkWirelessEthernetPortsProfileResponse –

  Successful operation.

{
  "profileId": "1001",
  "name": "Ap Port Profile Name",
  "isDefault": false,
  "ports": [
    {
      "name": "port 1",
      "number": 1,
      "enabled": true,
      "ssid": 1,
      "pskGroupId": "100"
    }
  ],
  "usbPorts": [
    {
      "name": "usb port",
      "enabled": true,
      "ssid": 5
    }
  ]
}

Creates new RF profile for this network.

API documentation: createNetworkWirelessRfProfile

Parameters:

• network_id (str) –

  Network ID.

• name (str) –

  The name of the new profile. Must be unique. This param is required on creation.

• client_balancing_enabled (bool | None, default: None ) –

  Steers client to best available access point. Can be either true or false. Defaults to true.

• min_bitrate_type (CreateNetworkWirelessRfProfileMinBitrateType | None, default: None ) –

  Minimum bitrate can be set to either 'band' or 'ssid'. Defaults to band.

• band_selection_type (CreateNetworkWirelessRfProfileBandSelectionType) –

  Band selection can be set to either 'ssid' or 'ap'. This param is required on creation.

• ap_band_settings (CreateNetworkWirelessRfProfileApBandSettings | None, default: None ) –

  Settings that will be enabled if selectionType is set to 'ap'.

• two_four_ghz_settings (CreateNetworkWirelessRfProfileTwoFourGhzSettings | None, default: None ) –

  Settings related to 2.4Ghz band.

• five_ghz_settings (CreateNetworkWirelessRfProfileFiveGhzSettings | None, default: None ) –

  Settings related to 5Ghz band.

• six_ghz_settings (CreateNetworkWirelessRfProfileSixGhzSettings | None, default: None ) –

  Settings related to 6Ghz band. Only applicable to networks with 6Ghz capable APs.

• transmission (CreateNetworkWirelessRfProfileTransmission | None, default: None ) –

  Settings related to radio transmission.

• per_ssid_settings (CreateNetworkWirelessRfProfilePerSsidSettings | None, default: None ) –

  Per-SSID radio settings by number.

• flex_radios (CreateNetworkWirelessRfProfileFlexRadios | None, default: None ) –

  Flex radio settings.

Returns:

• GetNetworkWirelessRfProfilesResponse –

  Successful operation.

{
  "id": "1234",
  "networkId": "N_24329156",
  "name": "Main Office",
  "clientBalancingEnabled": true,
  "minBitrateType": "band",
  "bandSelectionType": "ap",
  "apBandSettings": {
    "bandOperationMode": "dual",
    "bands": {
      "enabled": [
        "2.4",
        "5"
      ]
    },
    "bandSteeringEnabled": true
  },
  "twoFourGhzSettings": {
    "maxPower": 30,
    "minPower": 5,
    "minBitrate": 11.0,
    "validAutoChannels": [
      1,
      6,
      11
    ],
    "axEnabled": true,
    "rxsop": -95
  },
  "fiveGhzSettings": {
    "maxPower": 30,
    "minPower": 8,
    "minBitrate": 12,
    "validAutoChannels": [
      36,
      40,
      44,
      48,
      52,
      56,
      60,
      64,
      100,
      104,
      108,
      112,
      116,
      120,
      124,
      128,
      132,
      136,
      140,
      144,
      149,
      153,
      157,
      161,
      165
    ],
    "channelWidth": "auto",
    "rxsop": -95
  },
  "sixGhzSettings": {
    "maxPower": 30,
    "minPower": 8,
    "minBitrate": 12,
    "validAutoChannels": [
      1,
      5,
      9,
      13,
      17,
      21,
      25,
      29,
      33,
      37,
      41,
      45,
      49,
      53,
      57,
      61,
      65,
      69,
      73,
      77,
      81,
      85,
      89,
      93,
      97,
      101,
      105,
      109,
      113,
      117,
      121,
      125,
      129,
      133,
      137,
      141,
      145,
      149,
      153,
      157,
      161,
      165,
      169,
      173,
      177,
      181,
      185,
      189,
      193,
      197,
      201,
      205,
      209,
      213,
      217,
      221,
      225,
      229,
      233
    ],
    "channelWidth": "auto",
    "rxsop": -95
  },
  "transmission": {
    "enabled": true
  },
  "perSsidSettings": {
    "0": {
      "name": "SSID 0",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "1": {
      "name": "SSID 1",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "2": {
      "name": "SSID 2",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "3": {
      "name": "SSID 3",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "4": {
      "name": "SSID 4",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "5": {
      "name": "SSID 5",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "6": {
      "name": "SSID 6",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "7": {
      "name": "SSID 7",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "8": {
      "name": "SSID 8",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "9": {
      "name": "SSID 9",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "10": {
      "name": "SSID 10",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "11": {
      "name": "SSID 11",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "12": {
      "name": "SSID 12",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "13": {
      "name": "SSID 13",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "14": {
      "name": "SSID 14",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    }
  },
  "isIndoorDefault": false,
  "isOutdoorDefault": false
}

Create an Identity PSK.

API documentation: createNetworkWirelessSsidIdentityPsk

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• name (str) –

  The name of the Identity PSK.

• passphrase (str | None, default: None ) –

  The passphrase for client authentication. If left blank, one will be auto- generated.

• group_policy_id (str) –

  The group policy to be applied to clients.

• expires_at (str | None, default: None ) –

  Timestamp for when the Identity PSK expires. Will not expire if left blank.

Returns:

• NetworkWirelessSsidIdentityPskResponse –

  Successful operation.

{
  "name": "Sample Identity PSK",
  "id": "1284392014819",
  "groupPolicyId": "101",
  "passphrase": "secret",
  "wifiPersonalNetworkId": "1284392014819",
  "email": "miles@meraki.com",
  "expiresAt": "2018-02-11T00:00:00.090210Z"
}

Create a zero touch deployment for a wireless access point.

API documentation: createOrganizationWirelessDevicesProvisioningDeployment

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[CreateOrganizationWirelessDevicesProvisioningDeploymentItemsItem]) –

  List of zero touch deployments to create.

• meta (CreateOrganizationWirelessDevicesProvisioningDeploymentMeta | None, default: None ) –

  Metadata relevant to the paginated dataset.

Returns:

• UpdateOrganizationWirelessDevicesProvisioningDeploymentsResponse –

  Successful operation.

{
  "items": [
    {
      "deploymentId": "1284392014819",
      "devices": {
        "old": {
          "serial": "Q234-ABCD-5678",
          "afterAction": "unclaim",
          "name": "My AP",
          "model": "MR34",
          "mac": "00:11:22:33:44:55",
          "tags": [
            "tag1",
            "tag2"
          ],
          "rfProfile": {
            "id": "1284392014819",
            "name": "RF Profile Name"
          }
        },
        "new": {
          "serial": "Q234-ABCD-5678",
          "name": "My AP",
          "model": "CW9166I",
          "mac": "00:11:22:33:44:55",
          "tags": [
            "tag1",
            "tag2"
          ],
          "rfProfile": {
            "id": "1284392014819",
            "name": "RF Profile Name"
          }
        }
      },
      "status": "ready",
      "type": "replace",
      "network": {
        "id": "N_24329156",
        "name": "Main Office"
      },
      "createdAt": "2018-02-11T00:00:00.090210Z",
      "requestedAt": "2018-02-11T00:00:00.090210Z",
      "lastUpdatedAt": "2018-02-11T00:00:00.090210Z",
      "completedAt": "2018-02-11T00:00:00.090210Z",
      "errors": [
        "error message1",
        "error message2"
      ]
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 20,
        "remaining": 0
      }
    }
  }
}

Create an organization's RADSEC device Certificate Authority (CA).

API documentation: createOrganizationWirelessDevicesRadsecCertificatesAuthority

Parameters:

• organization_id (str) –

  Organization ID.

Returns:

• UpdateOrganizationWirelessDevicesRadsecCertificatesAuthoritiesResponse –

  Successful operation.

{
  "certificateAuthorityId": "1234",
  "status": "trusted",
  "contents": "-----BEGIN CERTIFICATE-----\nMIIDzDCCAragAwIBAgIUOd0ukLcjH43TfTHFG9qE0FtlMVgwCwYJKoZIhvcNAQEL\n...\numkqeYeO30g1uYvDuWLXVA==\n-----END CERTIFICATE-----\n"
}

Add new receiver for scanning API.

API documentation: createOrganizationWirelessLocationScanningReceiver

Parameters:

• organization_id (str) –

  Organization ID.

• network (CreateOrganizationWirelessLocationScanningReceiverNetwork) –

  Add scanning API receiver for network.

• url (str) –

  Receiver Url.

• version (str) –

  Scanning API Version.

• radio (CreateOrganizationWirelessLocationScanningReceiverRadio) –

  Add scanning API Radio.

• shared_secret (str) –

  Secret Value for Receiver.

Returns:

• OrganizationWirelessLocationScanningReceiverResponse –

  Successful operation.

{
  "network": {
    "id": "L_1234",
    "name": "My Network"
  },
  "receiverId": "1234567",
  "url": "https://www.myreceiver.com",
  "version": "3",
  "radio": {
    "type": "Wi-Fi"
  }
}

Create isolation allow list MAC entry for this organization.

API documentation: createOrganizationWirelessSsidsFirewallIsolationAllowlistEntry

Parameters:

• organization_id (str) –

  Organization ID.

• description (str | None, default: None ) –

  The description of mac address.

• client (CreateOrganizationWirelessSsidsFirewallIsolationAllowlistEntryClient) –

  The client of allowlist.

• ssid (CreateOrganizationWirelessSsidsFirewallIsolationAllowlistEntrySsid) –

  The SSID that allowlist belongs to.

• network (CreateOrganizationWirelessSsidsFirewallIsolationAllowlistEntryNetwork) –

  The Network that allowlist belongs to.

Returns:

• OrganizationWirelessSsidsFirewallIsolationAllowlistEntryResponse –

  Successful operation.

{
  "entryId": "1",
  "createdAt": "2024-11-11T07:16:38Z",
  "lastUpdatedAt": "2024-11-11T07:16:38Z",
  "description": "Example mac address",
  "client": {
    "mac": "A1:B2:C3:D4:E5:F6"
  },
  "ssid": {
    "id": "5",
    "name": "Test SSID",
    "number": 2
  },
  "network": {
    "id": "N_123",
    "name": "Test network"
  }
}

Enqueue a job to start disenrolling door locks on zigbee configured wireless devices.

API documentation: createOrganizationWirelessZigbeeDisenrollment

Parameters:

• organization_id (str) –

  Organization ID.

• door_lock_ids (list[str] | None, default: None ) –

  A list of Meraki door lock ids to disenroll from the device.

Returns:

• CreateOrganizationWirelessZigbeeDisenrollmentResponse –

  Successful operation.

{
  "disenrollmentId": "1234",
  "url": "/organization/{organizationId}/wireless/zigbee/disenrollments/1234",
  "request": {
    "doorLockIds": [
      "1234"
    ]
  },
  "status": "complete"
}

Delete an Air Marshal rule.

API documentation: deleteNetworkWirelessAirMarshalRule

Parameters:

• network_id (str) –

  Network ID.

• rule_id (str) –

  Rule ID.

Returns:

• None –

  Successful operation.

Delete an AP port profile.

API documentation: deleteNetworkWirelessEthernetPortsProfile

Parameters:

• network_id (str) –

  Network ID.

• profile_id (str) –

  Profile ID.

Returns:

• None –

  Successful operation.

Delete a RF Profile.

API documentation: deleteNetworkWirelessRfProfile

Parameters:

• network_id (str) –

  Network ID.

• rf_profile_id (str) –

  Rf profile ID.

Returns:

• None –

  Successful operation.

Delete an Identity PSK.

API documentation: deleteNetworkWirelessSsidIdentityPsk

Parameters:

• network_id (str) –

  Network ID.

• number (str) –

  Number.

• identity_psk_id (str) –

  Identity psk ID.

Returns:

• None –

  Successful operation.

Delete a zero touch deployment.

API documentation: deleteOrganizationWirelessDevicesProvisioningDeployment

Parameters:

• organization_id (str) –

  Organization ID.

• deployment_id (str) –

  Deployment ID.

Returns:

• None –

  Successful operation.

Delete a scanning API receiver.

API documentation: deleteOrganizationWirelessLocationScanningReceiver

Parameters:

• organization_id (str) –

  Organization ID.

• receiver_id (str) –

  Receiver ID.

Returns:

• None –

  Successful operation.

Destroy isolation allow list MAC entry for this organization.

API documentation: deleteOrganizationWirelessSsidsFirewallIsolationAllowlistEntry

Parameters:

• organization_id (str) –

  Organization ID.

• entry_id (str) –

  Entry ID.

Returns:

• None –

  Successful operation.

Return the bluetooth settings for a wireless device.

API documentation: getDeviceWirelessBluetoothSettings

Parameters:

• serial (str) –

  Serial.

Returns:

• DeviceWirelessBluetoothSettingsResponse –

  Successful operation.

{
  "uuid": "00000000-0000-0000-000-000000000000",
  "major": 13,
  "minor": 125
}

Aggregated connectivity info for a given AP on this network.

API documentation: getDeviceWirelessConnectionStats

Parameters:

• serial (str) –

  Serial.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 180 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 7 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.

• band (GetDeviceWirelessConnectionStatsBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.

• ssid (GetDeviceWirelessConnectionStatsSsid | None, default: None ) –

  Filter results by SSID.

• ap_tag (str | None, default: None ) –

  Filter results by AP Tag.

Returns:

• GetDeviceWirelessConnectionStatsResponse –

  Successful operation.

{
  "serial": "Q234-ABCD-5678",
  "connectionStats": {
    "assoc": 0,
    "auth": 1,
    "dhcp": 0,
    "dns": 0,
    "success": 43
  }
}

Return the ESL settings of a device.

API documentation: getDeviceWirelessElectronicShelfLabel

Parameters:

• serial (str) –

  Serial.

Returns:

• DeviceWirelessElectronicShelfLabelResponse –

  Successful operation.

{
  "apEslId": 16777216,
  "serial": "Q234-ABCD-5678",
  "channel": "1",
  "enabled": true,
  "networkId": "N_24329156",
  "hostname": "localhost:700",
  "provider": "imagotag"
}

Aggregated latency info for a given AP on this network.

API documentation: getDeviceWirelessLatencyStats

Parameters:

• serial (str) –

  Serial.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 180 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 7 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.

• band (GetDeviceWirelessLatencyStatsBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.

• ssid (GetDeviceWirelessLatencyStatsSsid | None, default: None ) –

  Filter results by SSID.

• ap_tag (str | None, default: None ) –

  Filter results by AP Tag.

• vlan (int | None, default: None ) –

  Filter results by VLAN.

• fields (str | None, default: None ) –

  Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.

Returns:

• GetDeviceWirelessLatencyStatsResponse –

  Successful operation.

{
  "serial": "Q2JC-2MJM-FHRD",
  "latencyStats": {
    "backgroundTraffic": {
      "avg": 606.52
    },
    "bestEffortTraffic": {
      "avg": 606.52
    },
    "videoTraffic": {
      "avg": 606.52
    },
    "voiceTraffic": {
      "avg": 606.52
    }
  }
}

Return the manually configured radio settings overrides of a device, which take precedence over RF profiles.

API documentation: getDeviceWirelessRadioSettings

Parameters:

• serial (str) –

  Serial.

Returns:

• DeviceWirelessRadioSettingsResponse –

  Successful operation.

{
  "serial": "Q234-ABCD-5678",
  "rfProfileId": "1234",
  "twoFourGhzSettings": {
    "channel": 11,
    "targetPower": 21
  },
  "fiveGhzSettings": {
    "channel": 149,
    "channelWidth": 20,
    "targetPower": 15
  }
}

Return the SSID statuses of an access point.

API documentation: getDeviceWirelessStatus

Parameters:

• serial (str) –

  Serial.

Returns:

• GetDeviceWirelessStatusResponse –

  Successful operation.

{
  "basicServiceSets": [
    {
      "ssidName": "My SSID",
      "ssidNumber": 0,
      "enabled": true,
      "band": "2.4 GHz",
      "bssid": "8A:15:04:00:00:00",
      "channel": 11,
      "channelWidth": "20 MHz",
      "power": "18 dBm",
      "visible": true,
      "broadcasting": true
    }
  ]
}

Return an enrollment.

API documentation: getDeviceWirelessZigbeeEnrollment

Parameters:

• serial (str) –

  Serial.

• enrollment_id (str) –

  Enrollment ID.

Returns:

• GetDeviceWirelessZigbeeEnrollmentResponse –

  Successful operation.

{
  "enrollmentId": "1234",
  "url": "/devices/SERIAL/wireless/zigbee/enrollments/1234",
  "request": {
    "serial": "Q234-ABCD-5678"
  },
  "status": "complete",
  "enrollmentStartedAt": "complete",
  "doorLocks": [
    {
      "doorLockId": "1",
      "name": "Door Lock 123",
      "shortId": "ABE123",
      "lqi": "1",
      "rssi": "1",
      "status": "online",
      "eui64": "DL403",
      "enrolledAt": "2023-08-14T19:57:06Z",
      "lastSeenAt": "2023-08-14T19:59:01Z",
      "network": {
        "id": "N_24329156",
        "name": "Main Office"
      },
      "gateway": {
        "name": "My AP",
        "serial": "Q234-ABCD-5678"
      }
    }
  ]
}

List Air Marshal scan results from a network.

API documentation: getNetworkWirelessAirMarshal

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.

Returns:

• PaginatedResponse[GetNetworkWirelessAirMarshalResponseItem] –

  Successful operation.

[
  {
    "ssid": "linksys",
    "bssids": [
      {
        "bssid": "00:11:22:33:44:55",
        "contained": false,
        "detectedBy": [
          {
            "device": "Q234-ABCD-5678",
            "rssi": 17
          }
        ]
      }
    ],
    "channels": [
      36,
      40
    ],
    "firstSeen": 1518365681,
    "lastSeen": 1526087474,
    "wiredMacs": [
      "00:11:22:33:44:55"
    ],
    "wiredVlans": [
      0,
      108
    ],
    "wiredLastSeen": 1526087474
  }
]

Return alternate management interface and devices with IP assigned.

API documentation: getNetworkWirelessAlternateManagementInterface

Parameters:

• network_id (str) –

  Network ID.

Returns:

• DictResponse –

  Successful operation.

{
  "enabled": true,
  "vlanId": 100,
  "protocols": [
    "radius",
    "snmp",
    "syslog",
    "ldap"
  ],
  "accessPoints": [
    {
      "serial": "Q234-ABCD-5678",
      "alternateManagementIp": "1.2.3.4",
      "subnetMask": "255.255.255.0",
      "gateway": "1.2.3.5",
      "dns1": "8.8.8.8",
      "dns2": "8.8.4.4"
    }
  ]
}

Return the billing settings of this network.

API documentation: getNetworkWirelessBilling

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkWirelessBillingResponse –

  Successful operation.

{
  "currency": "USD",
  "plans": [
    {
      "id": "1",
      "price": 5.0,
      "bandwidthLimits": {
        "limitUp": 1000,
        "limitDown": 1000
      },
      "timeLimit": "1 hour"
    }
  ]
}

Return the Bluetooth settings for a network. Bluetooth settings must be enabled on the network.

API documentation: getNetworkWirelessBluetoothSettings

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkWirelessBluetoothSettingsResponse –

  Successful operation.

{
  "scanningEnabled": true,
  "advertisingEnabled": true,
  "uuid": "00000000-0000-0000-000-000000000000",
  "majorMinorAssignmentMode": "Non-unique",
  "major": 1,
  "minor": 1,
  "eslEnabled": true
}

Return AP channel utilization over time for a device or network client.

API documentation: getNetworkWirelessChannelUtilizationHistory

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 31 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.

• resolution (int | None, default: None ) –

  The time resolution in seconds for returned data. The valid resolutions are: 600, 1200, 3600, 14400, 86400. The default is 86400.

• auto_resolution (bool | None, default: None ) –

  Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.

• client_id (str | None, default: None ) –

  Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history.

• device_serial (str | None, default: None ) –

  Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified.

• ap_tag (str | None, default: None ) –

  Filter results by AP tag to return AP channel utilization metrics for devices labeled with the given tag; either :clientId or :deviceSerial must be jointly specified.

• band (GetNetworkWirelessChannelUtilizationHistoryBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6').

Returns:

• PaginatedResponse[GetNetworkWirelessChannelUtilizationHistoryResponseItem] –

  Successful operation.

[
  {
    "startTs": "2020-01-01T00:00:00Z",
    "endTs": "2020-01-01T01:00:00Z",
    "utilizationTotal": 9.89,
    "utilization80211": 7.22,
    "utilizationNon80211": 2.67
  }
]

Aggregated connectivity info for a given client on this network.

API documentation: getNetworkWirelessClientConnectionStats

Parameters:

• network_id (str) –

  Network ID.

• client_id (str) –

  Client ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 180 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 7 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.

• band (GetNetworkWirelessClientConnectionStatsBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.

• ssid (GetNetworkWirelessClientConnectionStatsSsid | None, default: None ) –

  Filter results by SSID.

• ap_tag (str | None, default: None ) –

  Filter results by AP Tag.

Returns:

• GetNetworkWirelessClientConnectionStatsResponse –

  Successful operation.

{
  "mac": "00:11:22:33:44:55",
  "connectionStats": {
    "assoc": 3,
    "auth": 4,
    "dhcp": 4,
    "success": 5
  }
}

List the wireless connectivity events for a client within a network in the timespan.

API documentation: getNetworkWirelessClientConnectivityEvents

Parameters:

• network_id (str) –

  Network ID.

• client_id (str) –

  Client ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• sort_order (GetNetworkWirelessClientConnectivityEventsSortOrder | None, default: None ) –

  Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'ascending'.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 31 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day.

• types (GetNetworkWirelessClientConnectivityEventsTypes | None, default: None ) –

  A list of event types to include. If not specified, events of all types will be returned. Valid types are 'assoc', 'disassoc', 'auth', 'deauth', 'dns', 'dhcp', 'roam', 'connection' and/or 'sticky'.

• band (GetNetworkWirelessClientConnectivityEventsBand | None, default: None ) –

  Filter results by band. Valid bands are '2.4', '5' or '6'.

• ssid_number (GetNetworkWirelessClientConnectivityEventsSsidNumber | None, default: None ) –

  Filter results by SSID. If not specified, events for all SSIDs will be returned.

• included_severities (GetNetworkWirelessClientConnectivityEventsIncludedSeverities | None, default: None ) –

  A list of severities to include. If not specified, events of all severities will be returned. Valid severities are 'good', 'info', 'warn' and/or 'bad'.

• device_serial (str | None, default: None ) –

  Filter results by an AP's serial number.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkWirelessClientConnectivityEventsResponseItem] –

  Successful operation.

[
  {
    "occurredAt": "2018-02-11T00:00:00.090210Z",
    "band": "5",
    "ssidNumber": 1,
    "type": "auth",
    "subtype": "success",
    "severity": "bad",
    "durationMs": 100,
    "channel": 44,
    "rssi": 80,
    "deviceSerial": "Q234-ABCD-5678",
    "captureId": "123456"
  }
]

Return wireless client counts over time for a network, device, or network client.

API documentation: getNetworkWirelessClientCountHistory

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 31 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.

• resolution (int | None, default: None ) –

  The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.

• auto_resolution (bool | None, default: None ) –

  Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.

• client_id (str | None, default: None ) –

  Filter results by network client to return per-device client counts over time inner joined by the queried client's connection history.

• device_serial (str | None, default: None ) –

  Filter results by device.

• ap_tag (str | None, default: None ) –

  Filter results by AP tag.

• band (GetNetworkWirelessClientCountHistoryBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6').

• ssid (int | None, default: None ) –

  Filter results by SSID number.

Returns:

• PaginatedResponse[GetNetworkWirelessClientCountHistoryResponseItem] –

  Successful operation.

[
  {
    "startTs": "2020-01-01T00:00:00Z",
    "endTs": "2020-01-01T01:00:00Z",
    "clientCount": 14
  }
]

Return the latency history for a client.

API documentation: getNetworkWirelessClientLatencyHistory

Parameters:

• network_id (str) –

  Network ID.

• client_id (str) –

  Client ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 791 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 791 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 791 days. The default is 1 day.

• resolution (int | None, default: None ) –

  The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400.

Returns:

• PaginatedResponse[GetNetworkWirelessClientLatencyHistoryResponseItem] –

  Successful operation.

[
  {
    "t0": 1550534400,
    "t1": 1550620800,
    "latencyBinsByCategory": {
      "backgroundTraffic": {
        "0.5": 41750,
        "1.0": 21552,
        "2.0": 59940,
        "4.0": 146622,
        "8.0": 57354,
        "16.0": 0,
        "32.0": 9954,
        "64.0": 0,
        "128.0": 0,
        "256.0": 1896,
        "512.0": 0,
        "1024.0": 0,
        "2048.0": 0
      },
      "bestEffortTraffic": {
        "0.5": 1840899,
        "1.0": 1644506,
        "2.0": 629958,
        "4.0": 449564,
        "8.0": 2009658,
        "16.0": 1329568,
        "32.0": 282168,
        "64.0": 97573,
        "128.0": 191977,
        "256.0": 30560,
        "512.0": 26032,
        "1024.0": 4943,
        "2048.0": 12072
      },
      "videoTraffic": {
        "0.5": 0,
        "1.0": 0,
        "2.0": 0,
        "4.0": 0,
        "8.0": 0,
        "16.0": 0,
        "32.0": 0,
        "64.0": 0,
        "128.0": 0,
        "256.0": 0,
        "512.0": 0,
        "1024.0": 0,
        "2048.0": 0
      },
      "voiceTraffic": {
        "0.5": 716,
        "1.0": 948,
        "2.0": 474,
        "4.0": 78,
        "8.0": 0,
        "16.0": 0,
        "32.0": 0,
        "64.0": 0,
        "128.0": 0,
        "256.0": 0,
        "512.0": 0,
        "1024.0": 0,
        "2048.0": 0
      }
    }
  }
]

Aggregated latency info for a given client on this network.

API documentation: getNetworkWirelessClientLatencyStats

Parameters:

• network_id (str) –

  Network ID.

• client_id (str) –

  Client ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 180 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 7 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.

• band (GetNetworkWirelessClientLatencyStatsBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.

• ssid (GetNetworkWirelessClientLatencyStatsSsid | None, default: None ) –

  Filter results by SSID.

• ap_tag (str | None, default: None ) –

  Filter results by AP Tag.

• vlan (int | None, default: None ) –

  Filter results by VLAN.

• fields (str | None, default: None ) –

  Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.

Returns:

• GetNetworkWirelessClientLatencyStatsResponse –

  Successful operation.

{
  "mac": "00:61:71:c8:51:27",
  "latencyStats": {
    "backgroundTraffic": {
      "avg": 606.52
    },
    "bestEffortTraffic": {
      "avg": 606.52
    },
    "videoTraffic": {
      "avg": 606.52
    },
    "voiceTraffic": {
      "avg": 606.52
    }
  }
}

Aggregated connectivity info for this network, grouped by clients.

API documentation: getNetworkWirelessClientsConnectionStats

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 180 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 7 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.

• band (GetNetworkWirelessClientsConnectionStatsBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.

• ssid (GetNetworkWirelessClientsConnectionStatsSsid | None, default: None ) –

  Filter results by SSID.

• ap_tag (str | None, default: None ) –

  Filter results by AP Tag.

Returns:

• PaginatedResponse[GetNetworkWirelessClientsConnectionStatsResponseItem] –

  Successful operation.

[
  {
    "mac": "00:61:71:c8:51:27",
    "connectionStats": {
      "assoc": 0,
      "auth": 4,
      "dhcp": 0,
      "dns": 0,
      "success": 10
    }
  }
]

Aggregated latency info for this network, grouped by clients.

API documentation: getNetworkWirelessClientsLatencyStats

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 180 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 7 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.

• band (GetNetworkWirelessClientsLatencyStatsBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.

• ssid (GetNetworkWirelessClientsLatencyStatsSsid | None, default: None ) –

  Filter results by SSID.

• ap_tag (str | None, default: None ) –

  Filter results by AP Tag.

• vlan (int | None, default: None ) –

  Filter results by VLAN.

• fields (str | None, default: None ) –

  Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.

Returns:

• PaginatedResponse[GetNetworkWirelessClientLatencyStatsResponse] –

  Successful operation.

[
  {
    "mac": "00:61:71:c8:51:27",
    "latencyStats": {
      "backgroundTraffic": {
        "avg": 606.52
      },
      "bestEffortTraffic": {
        "avg": 606.52
      },
      "videoTraffic": {
        "avg": 606.52
      },
      "voiceTraffic": {
        "avg": 606.52
      }
    }
  }
]

Aggregated connectivity info for this network.

API documentation: getNetworkWirelessConnectionStats

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 180 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 7 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.

• band (GetNetworkWirelessConnectionStatsBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.

• ssid (GetNetworkWirelessConnectionStatsSsid | None, default: None ) –

  Filter results by SSID.

• ap_tag (str | None, default: None ) –

  Filter results by AP Tag.

Returns:

• GetNetworkWirelessConnectionStatsResponse –

  Successful operation.

{
  "assoc": 1,
  "auth": 5,
  "dhcp": 0,
  "dns": 0,
  "success": 51
}

Return PHY data rates over time for a network, device, or network client.

API documentation: getNetworkWirelessDataRateHistory

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 31 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.

• resolution (int | None, default: None ) –

  The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.

• auto_resolution (bool | None, default: None ) –

  Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.

• client_id (str | None, default: None ) –

  Filter results by network client.

• device_serial (str | None, default: None ) –

  Filter results by device.

• ap_tag (str | None, default: None ) –

  Filter results by AP tag.

• band (GetNetworkWirelessDataRateHistoryBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6').

• ssid (int | None, default: None ) –

  Filter results by SSID number.

Returns:

• PaginatedResponse[GetNetworkWirelessDataRateHistoryResponseItem] –

  Successful operation.

[
  {
    "startTs": "2020-01-01T00:00:00Z",
    "endTs": "2020-01-01T01:00:00Z",
    "averageKbps": 151806,
    "downloadKbps": 144839,
    "uploadKbps": 158837
  }
]

Aggregated connectivity info for this network, grouped by node.

API documentation: getNetworkWirelessDevicesConnectionStats

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 180 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 7 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.

• band (GetNetworkWirelessDevicesConnectionStatsBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.

• ssid (GetNetworkWirelessDevicesConnectionStatsSsid | None, default: None ) –

  Filter results by SSID.

• ap_tag (str | None, default: None ) –

  Filter results by AP Tag.

Returns:

• PaginatedResponse[GetDeviceWirelessConnectionStatsResponse] –

  Successful operation.

[
  {
    "serial": "Q234-ABCD-5678",
    "connectionStats": {
      "assoc": 0,
      "auth": 1,
      "dhcp": 0,
      "dns": 0,
      "success": 43
    }
  }
]

Aggregated latency info for this network, grouped by node.

API documentation: getNetworkWirelessDevicesLatencyStats

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 180 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 7 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.

• band (GetNetworkWirelessDevicesLatencyStatsBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.

• ssid (GetNetworkWirelessDevicesLatencyStatsSsid | None, default: None ) –

  Filter results by SSID.

• ap_tag (str | None, default: None ) –

  Filter results by AP Tag.

• vlan (int | None, default: None ) –

  Filter results by VLAN.

• fields (str | None, default: None ) –

  Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.

Returns:

• PaginatedResponse[GetDeviceWirelessLatencyStatsResponse] –

  Successful operation.

[
  {
    "serial": "Q2JC-2MJM-FHRD",
    "latencyStats": {
      "backgroundTraffic": {
        "avg": 606.52
      },
      "bestEffortTraffic": {
        "avg": 606.52
      },
      "videoTraffic": {
        "avg": 606.52
      },
      "voiceTraffic": {
        "avg": 606.52
      }
    }
  }
]

Return the ESL settings of a wireless network.

API documentation: getNetworkWirelessElectronicShelfLabel

Parameters:

• network_id (str) –

  Network ID.

Returns:

• NetworkWirelessElectronicShelfLabelResponse –

  Successful operation.

{
  "hostname": "example.com",
  "enabled": true,
  "mode": "high frequency",
  "sepioo": {
    "hostname": "example.com"
  }
}

Get a list of all ESL eligible devices of a network.

API documentation: getNetworkWirelessElectronicShelfLabelConfiguredDevices

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[NetworkWirelessElectronicShelfLabelResponse] –

  Successful operation.

[
  {
    "hostname": "example.com",
    "enabled": true,
    "mode": "high frequency",
    "sepioo": {
      "hostname": "example.com"
    }
  }
]

Show the AP port profile by ID for this network.

API documentation: getNetworkWirelessEthernetPortsProfile

Parameters:

• network_id (str) –

  Network ID.

• profile_id (str) –

  Profile ID.

Returns:

• NetworkWirelessEthernetPortsProfileResponse –

  Successful operation.

{
  "profileId": "1001",
  "name": "Ap Port Profile Name",
  "isDefault": false,
  "ports": [
    {
      "name": "port 1",
      "number": 1,
      "enabled": true,
      "ssid": 1,
      "pskGroupId": "100"
    }
  ],
  "usbPorts": [
    {
      "name": "usb port",
      "enabled": true,
      "ssid": 5
    }
  ]
}

List the AP port profiles for this network.

API documentation: getNetworkWirelessEthernetPortsProfiles

Parameters:

• network_id (str) –

  Network ID.

Returns:

• PaginatedResponse[NetworkWirelessEthernetPortsProfileResponse] –

  Successful operation.

[
  {
    "profileId": "1001",
    "name": "Ap Port Profile Name",
    "isDefault": false,
    "ports": [
      {
        "name": "port 1",
        "number": 1,
        "enabled": true,
        "ssid": 1,
        "pskGroupId": "100"
      }
    ],
    "usbPorts": [
      {
        "name": "usb port",
        "enabled": true,
        "ssid": 5
      }
    ]
  }
]

List of all failed client connection events on this network in a given time range.

API documentation: getNetworkWirelessFailedConnections

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 180 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 7 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.

• band (GetNetworkWirelessFailedConnectionsBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.

• ssid (GetNetworkWirelessFailedConnectionsSsid | None, default: None ) –

  Filter results by SSID.

• ap_tag (str | None, default: None ) –

  Filter results by AP Tag.

• serial (str | None, default: None ) –

  Filter by AP.

• client_id (str | None, default: None ) –

  Filter by client MAC.

Returns:

• PaginatedResponse[GetNetworkWirelessFailedConnectionsResponseItem] –

  Successful operation.

[
  {
    "ssidNumber": 1,
    "vlan": 100,
    "clientMac": "22:33:44:55:66:77",
    "serial": "Q234-ABCD-5678",
    "radio": 0,
    "failureStep": "dns",
    "type": "802.1X auth fail",
    "ts": "2018-02-11T00:00:00.090210Z"
  }
]

Return average wireless latency over time for a network, device, or network client.

API documentation: getNetworkWirelessLatencyHistory

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 31 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 7 days.

• resolution (int | None, default: None ) –

  The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400.

• auto_resolution (bool | None, default: None ) –

  Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false.

• client_id (str | None, default: None ) –

  Filter results by network client.

• device_serial (str | None, default: None ) –

  Filter results by device.

• ap_tag (str | None, default: None ) –

  Filter results by AP tag.

• band (GetNetworkWirelessLatencyHistoryBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6').

• ssid (int | None, default: None ) –

  Filter results by SSID number.

• access_category (GetNetworkWirelessLatencyHistoryAccessCategory | None, default: None ) –

  Filter by access category.

Returns:

• PaginatedResponse[GetNetworkWirelessLatencyHistoryResponseItem] –

  Successful operation.

[
  {
    "startTs": "2020-01-01T00:00:00Z",
    "endTs": "2020-01-01T01:00:00Z",
    "avgLatencyMs": 29
  }
]

Aggregated latency info for this network.

API documentation: getNetworkWirelessLatencyStats

Parameters:

• network_id (str) –

  Network ID.

• t0 (str | None, default: None ) –

  The beginning of the timespan for the data. The maximum lookback period is 180 days from today.

• t1 (str | None, default: None ) –

  The end of the timespan for the data. t1 can be a maximum of 7 days after t0.

• timespan (float | None, default: None ) –

  The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days.

• band (GetNetworkWirelessLatencyStatsBand | None, default: None ) –

  Filter results by band (either '2.4', '5' or '6'). Note that data prior to February 2020 will not have band information.

• ssid (GetNetworkWirelessLatencyStatsSsid | None, default: None ) –

  Filter results by SSID.

• ap_tag (str | None, default: None ) –

  Filter results by AP Tag.

• vlan (int | None, default: None ) –

  Filter results by VLAN.

• fields (str | None, default: None ) –

  Partial selection: If present, this call will return only the selected fields of ["rawDistribution", "avg"]. All fields will be returned by default. Selected fields must be entered as a comma separated string.

Returns:

• GetNetworkWirelessLatencyStatsResponse –

  Successful operation.

{
  "backgroundTraffic": {
    "avg": 606.52
  },
  "bestEffortTraffic": {
    "avg": 606.52
  },
  "videoTraffic": {
    "avg": 606.52
  },
  "voiceTraffic": {
    "avg": 606.52
  }
}

List wireless mesh statuses for repeaters.

API documentation: getNetworkWirelessMeshStatuses

Parameters:

• network_id (str) –

  Network ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 500. Default is 50.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkWirelessMeshStatusesResponseItem] –

  Successful operation.

[
  {
    "serial": "Q234-ABCD-5678",
    "meshRoute": [
      "Q234-ABCD-5678",
      "QWEY-SKTD-ST01",
      "QWEY-SKTD-ST02"
    ],
    "latestMeshPerformance": {
      "mbps": 43,
      "metric": 12345,
      "usagePercentage": "100%"
    }
  }
]

Return a RF profile.

API documentation: getNetworkWirelessRfProfile

Parameters:

• network_id (str) –

  Network ID.

• rf_profile_id (str) –

  Rf profile ID.

Returns:

• GetNetworkWirelessRfProfilesResponse –

  Successful operation.

{
  "id": "1234",
  "networkId": "N_24329156",
  "name": "Main Office",
  "clientBalancingEnabled": true,
  "minBitrateType": "band",
  "bandSelectionType": "ap",
  "apBandSettings": {
    "bandOperationMode": "dual",
    "bands": {
      "enabled": [
        "2.4",
        "5"
      ]
    },
    "bandSteeringEnabled": true
  },
  "twoFourGhzSettings": {
    "maxPower": 30,
    "minPower": 5,
    "minBitrate": 11.0,
    "validAutoChannels": [
      1,
      6,
      11
    ],
    "axEnabled": true,
    "rxsop": -95
  },
  "fiveGhzSettings": {
    "maxPower": 30,
    "minPower": 8,
    "minBitrate": 12,
    "validAutoChannels": [
      36,
      40,
      44,
      48,
      52,
      56,
      60,
      64,
      100,
      104,
      108,
      112,
      116,
      120,
      124,
      128,
      132,
      136,
      140,
      144,
      149,
      153,
      157,
      161,
      165
    ],
    "channelWidth": "auto",
    "rxsop": -95
  },
  "sixGhzSettings": {
    "maxPower": 30,
    "minPower": 8,
    "minBitrate": 12,
    "validAutoChannels": [
      1,
      5,
      9,
      13,
      17,
      21,
      25,
      29,
      33,
      37,
      41,
      45,
      49,
      53,
      57,
      61,
      65,
      69,
      73,
      77,
      81,
      85,
      89,
      93,
      97,
      101,
      105,
      109,
      113,
      117,
      121,
      125,
      129,
      133,
      137,
      141,
      145,
      149,
      153,
      157,
      161,
      165,
      169,
      173,
      177,
      181,
      185,
      189,
      193,
      197,
      201,
      205,
      209,
      213,
      217,
      221,
      225,
      229,
      233
    ],
    "channelWidth": "auto",
    "rxsop": -95
  },
  "transmission": {
    "enabled": true
  },
  "perSsidSettings": {
    "0": {
      "name": "SSID 0",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "1": {
      "name": "SSID 1",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "2": {
      "name": "SSID 2",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "3": {
      "name": "SSID 3",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "4": {
      "name": "SSID 4",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "5": {
      "name": "SSID 5",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "6": {
      "name": "SSID 6",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "7": {
      "name": "SSID 7",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "8": {
      "name": "SSID 8",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "9": {
      "name": "SSID 9",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "10": {
      "name": "SSID 10",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "11": {
      "name": "SSID 11",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "12": {
      "name": "SSID 12",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "13": {
      "name": "SSID 13",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    },
    "14": {
      "name": "SSID 14",
      "minBitrate": 11,
      "bandOperationMode": "dual",
      "bands": {
        "enabled": [
          "2.4",
          "5"
        ]
      },
      "bandSteeringEnabled": true
    }
  },
  "isIndoorDefault": false,
  "isOutdoorDefault": false
}