Documentation

__construct()


    public
                __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null

Return values

mixed —

generateDeviceCameraSnapshot()

Operation generateDeviceCameraSnapshot


    public
                generateDeviceCameraSnapshot(string $serial[, GenerateDeviceCameraSnapshot $generate_device_camera_snapshot = null ]) : object

Generate a snapshot of what the camera sees at the specified time and return a link to that image.

Parameters

$serial : string: serial (required)
$generate_device_camera_snapshot : GenerateDeviceCameraSnapshot = null: generate_device_camera_snapshot (optional)

Tags

Return values

object —

generateDeviceCameraSnapshotAsync()

Operation generateDeviceCameraSnapshotAsync


    public
                generateDeviceCameraSnapshotAsync(string $serial[, GenerateDeviceCameraSnapshot $generate_device_camera_snapshot = null ]) : PromiseInterface

Generate a snapshot of what the camera sees at the specified time and return a link to that image.

Parameters

$serial : string: (required)
$generate_device_camera_snapshot : GenerateDeviceCameraSnapshot = null: (optional)

Tags

Return values

PromiseInterface —

generateDeviceCameraSnapshotAsyncWithHttpInfo()

Operation generateDeviceCameraSnapshotAsyncWithHttpInfo


    public
                generateDeviceCameraSnapshotAsyncWithHttpInfo(string $serial[, GenerateDeviceCameraSnapshot $generate_device_camera_snapshot = null ]) : PromiseInterface

Generate a snapshot of what the camera sees at the specified time and return a link to that image.

Parameters

$serial : string: (required)
$generate_device_camera_snapshot : GenerateDeviceCameraSnapshot = null: (optional)

Tags

Return values

PromiseInterface —

generateDeviceCameraSnapshotWithHttpInfo()

Operation generateDeviceCameraSnapshotWithHttpInfo


    public
                generateDeviceCameraSnapshotWithHttpInfo(string $serial[, GenerateDeviceCameraSnapshot $generate_device_camera_snapshot = null ]) : array<string|int, mixed>

Generate a snapshot of what the camera sees at the specified time and return a link to that image.

Parameters

$serial : string: (required)
$generate_device_camera_snapshot : GenerateDeviceCameraSnapshot = null: (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                getConfig() : Configuration

Return values

Configuration —

getDeviceApplianceDhcpSubnets()

Operation getDeviceApplianceDhcpSubnets


    public
                getDeviceApplianceDhcpSubnets(string $serial) : object

Return the DHCP subnet information for an appliance

Parameters

$serial : string: serial (required)

Tags

Return values

object —

getDeviceApplianceDhcpSubnetsAsync()

Operation getDeviceApplianceDhcpSubnetsAsync


    public
                getDeviceApplianceDhcpSubnetsAsync(string $serial) : PromiseInterface

Return the DHCP subnet information for an appliance

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceApplianceDhcpSubnetsAsyncWithHttpInfo()

Operation getDeviceApplianceDhcpSubnetsAsyncWithHttpInfo


    public
                getDeviceApplianceDhcpSubnetsAsyncWithHttpInfo(string $serial) : PromiseInterface

Return the DHCP subnet information for an appliance

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceApplianceDhcpSubnetsWithHttpInfo()

Operation getDeviceApplianceDhcpSubnetsWithHttpInfo


    public
                getDeviceApplianceDhcpSubnetsWithHttpInfo(string $serial) : array<string|int, mixed>

Return the DHCP subnet information for an appliance

Parameters

$serial : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceAppliancePerformance()

Operation getDeviceAppliancePerformance


    public
                getDeviceAppliancePerformance(string $serial) : object

Return the performance score for a single MX

Parameters

$serial : string: serial (required)

Tags

Return values

object —

getDeviceAppliancePerformanceAsync()

Operation getDeviceAppliancePerformanceAsync


    public
                getDeviceAppliancePerformanceAsync(string $serial) : PromiseInterface

Return the performance score for a single MX

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceAppliancePerformanceAsyncWithHttpInfo()

Operation getDeviceAppliancePerformanceAsyncWithHttpInfo


    public
                getDeviceAppliancePerformanceAsyncWithHttpInfo(string $serial) : PromiseInterface

Return the performance score for a single MX

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceAppliancePerformanceWithHttpInfo()

Operation getDeviceAppliancePerformanceWithHttpInfo


    public
                getDeviceAppliancePerformanceWithHttpInfo(string $serial) : array<string|int, mixed>

Return the performance score for a single MX

Parameters

$serial : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraAnalyticsLive()

Operation getDeviceCameraAnalyticsLive


    public
                getDeviceCameraAnalyticsLive(string $serial) : object

Returns live state from camera of analytics zones

Parameters

$serial : string: serial (required)

Tags

Return values

object —

getDeviceCameraAnalyticsLiveAsync()

Operation getDeviceCameraAnalyticsLiveAsync


    public
                getDeviceCameraAnalyticsLiveAsync(string $serial) : PromiseInterface

Returns live state from camera of analytics zones

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceCameraAnalyticsLiveAsyncWithHttpInfo()

Operation getDeviceCameraAnalyticsLiveAsyncWithHttpInfo


    public
                getDeviceCameraAnalyticsLiveAsyncWithHttpInfo(string $serial) : PromiseInterface

Returns live state from camera of analytics zones

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceCameraAnalyticsLiveWithHttpInfo()

Operation getDeviceCameraAnalyticsLiveWithHttpInfo


    public
                getDeviceCameraAnalyticsLiveWithHttpInfo(string $serial) : array<string|int, mixed>

Returns live state from camera of analytics zones

Parameters

$serial : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraAnalyticsOverview()

Operation getDeviceCameraAnalyticsOverview


    public
                getDeviceCameraAnalyticsOverview(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : object

Returns an overview of aggregate analytics data for a timespan

Parameters

$serial : string: serial (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. The default is 1 hour. (optional)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

object —

getDeviceCameraAnalyticsOverviewAsync()

Operation getDeviceCameraAnalyticsOverviewAsync


    public
                getDeviceCameraAnalyticsOverviewAsync(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : PromiseInterface

Returns an overview of aggregate analytics data for a timespan

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. The default is 1 hour. (optional)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

PromiseInterface —

getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo()

Operation getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo


    public
                getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : PromiseInterface

Returns an overview of aggregate analytics data for a timespan

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. The default is 1 hour. (optional)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

PromiseInterface —

getDeviceCameraAnalyticsOverviewWithHttpInfo()

Operation getDeviceCameraAnalyticsOverviewWithHttpInfo


    public
                getDeviceCameraAnalyticsOverviewWithHttpInfo(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : array<string|int, mixed>

Returns an overview of aggregate analytics data for a timespan

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. The default is 1 hour. (optional)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraAnalyticsRecent()

Operation getDeviceCameraAnalyticsRecent


    public
                getDeviceCameraAnalyticsRecent(string $serial[, string $object_type = null ]) : object

Returns most recent record for analytics zones

Parameters

$serial : string: serial (required)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

object —

getDeviceCameraAnalyticsRecentAsync()

Operation getDeviceCameraAnalyticsRecentAsync


    public
                getDeviceCameraAnalyticsRecentAsync(string $serial[, string $object_type = null ]) : PromiseInterface

Returns most recent record for analytics zones

Parameters

$serial : string: (required)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

PromiseInterface —

getDeviceCameraAnalyticsRecentAsyncWithHttpInfo()

Operation getDeviceCameraAnalyticsRecentAsyncWithHttpInfo


    public
                getDeviceCameraAnalyticsRecentAsyncWithHttpInfo(string $serial[, string $object_type = null ]) : PromiseInterface

Returns most recent record for analytics zones

Parameters

$serial : string: (required)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

PromiseInterface —

getDeviceCameraAnalyticsRecentWithHttpInfo()

Operation getDeviceCameraAnalyticsRecentWithHttpInfo


    public
                getDeviceCameraAnalyticsRecentWithHttpInfo(string $serial[, string $object_type = null ]) : array<string|int, mixed>

Returns most recent record for analytics zones

Parameters

$serial : string: (required)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraAnalyticsZoneHistory()

Operation getDeviceCameraAnalyticsZoneHistory


    public
                getDeviceCameraAnalyticsZoneHistory(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : object

Return historical records for analytic zones

Parameters

$serial : string: serial (required)
$zone_id : string: zone_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 14 hours after t0. (optional)
$timespan : float = null: 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 14 hours. The default is 1 hour. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (optional)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

object —

getDeviceCameraAnalyticsZoneHistoryAsync()

Operation getDeviceCameraAnalyticsZoneHistoryAsync


    public
                getDeviceCameraAnalyticsZoneHistoryAsync(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : PromiseInterface

Return historical records for analytic zones

Parameters

$serial : string: (required)
$zone_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 14 hours after t0. (optional)
$timespan : float = null: 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 14 hours. The default is 1 hour. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (optional)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

PromiseInterface —

getDeviceCameraAnalyticsZoneHistoryAsyncWithHttpInfo()

Operation getDeviceCameraAnalyticsZoneHistoryAsyncWithHttpInfo


    public
                getDeviceCameraAnalyticsZoneHistoryAsyncWithHttpInfo(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : PromiseInterface

Return historical records for analytic zones

Parameters

$serial : string: (required)
$zone_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 14 hours after t0. (optional)
$timespan : float = null: 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 14 hours. The default is 1 hour. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (optional)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

PromiseInterface —

getDeviceCameraAnalyticsZoneHistoryWithHttpInfo()

Operation getDeviceCameraAnalyticsZoneHistoryWithHttpInfo


    public
                getDeviceCameraAnalyticsZoneHistoryWithHttpInfo(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : array<string|int, mixed>

Return historical records for analytic zones

Parameters

$serial : string: (required)
$zone_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 14 hours after t0. (optional)
$timespan : float = null: 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 14 hours. The default is 1 hour. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (optional)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraAnalyticsZones()

Operation getDeviceCameraAnalyticsZones


    public
                getDeviceCameraAnalyticsZones(string $serial) : object

Returns all configured analytic zones for this camera

Parameters

$serial : string: serial (required)

Tags

Return values

object —

getDeviceCameraAnalyticsZonesAsync()

Operation getDeviceCameraAnalyticsZonesAsync


    public
                getDeviceCameraAnalyticsZonesAsync(string $serial) : PromiseInterface

Returns all configured analytic zones for this camera

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceCameraAnalyticsZonesAsyncWithHttpInfo()

Operation getDeviceCameraAnalyticsZonesAsyncWithHttpInfo


    public
                getDeviceCameraAnalyticsZonesAsyncWithHttpInfo(string $serial) : PromiseInterface

Returns all configured analytic zones for this camera

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceCameraAnalyticsZonesWithHttpInfo()

Operation getDeviceCameraAnalyticsZonesWithHttpInfo


    public
                getDeviceCameraAnalyticsZonesWithHttpInfo(string $serial) : array<string|int, mixed>

Returns all configured analytic zones for this camera

Parameters

$serial : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceClients()

Operation getDeviceClients


    public
                getDeviceClients(string $serial[, string $t0 = null ][, float $timespan = null ]) : object

List the clients of a device, up to a maximum of a month ago

Parameters

$serial : string: serial (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)

Tags

Return values

object —

getDeviceClientsAsync()

Operation getDeviceClientsAsync


    public
                getDeviceClientsAsync(string $serial[, string $t0 = null ][, float $timespan = null ]) : PromiseInterface

List the clients of a device, up to a maximum of a month ago

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)

Tags

Return values

PromiseInterface —

getDeviceClientsAsyncWithHttpInfo()

Operation getDeviceClientsAsyncWithHttpInfo


    public
                getDeviceClientsAsyncWithHttpInfo(string $serial[, string $t0 = null ][, float $timespan = null ]) : PromiseInterface

List the clients of a device, up to a maximum of a month ago

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)

Tags

Return values

PromiseInterface —

getDeviceClientsWithHttpInfo()

Operation getDeviceClientsWithHttpInfo


    public
                getDeviceClientsWithHttpInfo(string $serial[, string $t0 = null ][, float $timespan = null ]) : array<string|int, mixed>

List the clients of a device, up to a maximum of a month ago

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceLldpCdp()

Operation getDeviceLldpCdp


    public
                getDeviceLldpCdp(string $serial) : object

List LLDP and CDP information for a device

Parameters

$serial : string: serial (required)

Tags

Return values

object —

getDeviceLldpCdpAsync()

Operation getDeviceLldpCdpAsync


    public
                getDeviceLldpCdpAsync(string $serial) : PromiseInterface

List LLDP and CDP information for a device

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceLldpCdpAsyncWithHttpInfo()

Operation getDeviceLldpCdpAsyncWithHttpInfo


    public
                getDeviceLldpCdpAsyncWithHttpInfo(string $serial) : PromiseInterface

List LLDP and CDP information for a device

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceLldpCdpWithHttpInfo()

Operation getDeviceLldpCdpWithHttpInfo


    public
                getDeviceLldpCdpWithHttpInfo(string $serial) : array<string|int, mixed>

List LLDP and CDP information for a device

Parameters

$serial : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceLossAndLatencyHistory()

Operation getDeviceLossAndLatencyHistory


    public
                getDeviceLossAndLatencyHistory(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : object

Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.

Parameters

$serial : string: serial (required)
$ip : string: The destination IP used to obtain the requested stats. This is required. (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60, 600, 3600, 86400. The default is 60. (optional)
$uplink : string = null: The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)

Tags

Return values

object —

getDeviceLossAndLatencyHistoryAsync()

Operation getDeviceLossAndLatencyHistoryAsync


    public
                getDeviceLossAndLatencyHistoryAsync(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : PromiseInterface

Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.

Parameters

$serial : string: (required)
$ip : string: The destination IP used to obtain the requested stats. This is required. (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60, 600, 3600, 86400. The default is 60. (optional)
$uplink : string = null: The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)

Tags

Return values

PromiseInterface —

getDeviceLossAndLatencyHistoryAsyncWithHttpInfo()

Operation getDeviceLossAndLatencyHistoryAsyncWithHttpInfo


    public
                getDeviceLossAndLatencyHistoryAsyncWithHttpInfo(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : PromiseInterface

Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.

Parameters

$serial : string: (required)
$ip : string: The destination IP used to obtain the requested stats. This is required. (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60, 600, 3600, 86400. The default is 60. (optional)
$uplink : string = null: The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)

Tags

Return values

PromiseInterface —

getDeviceLossAndLatencyHistoryWithHttpInfo()

Operation getDeviceLossAndLatencyHistoryWithHttpInfo


    public
                getDeviceLossAndLatencyHistoryWithHttpInfo(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : array<string|int, mixed>

Get the uplink loss percentage and latency in milliseconds, and goodput in kilobits per second for a wired network device.

Parameters

$serial : string: (required)
$ip : string: The destination IP used to obtain the requested stats. This is required. (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60, 600, 3600, 86400. The default is 60. (optional)
$uplink : string = null: The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceSwitchPortsStatuses()

Operation getDeviceSwitchPortsStatuses


    public
                getDeviceSwitchPortsStatuses(string $serial[, string $t0 = null ][, float $timespan = null ]) : object

Return the status for all the ports of a switch

Parameters

$serial : string: serial (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)

Tags

Return values

object —

getDeviceSwitchPortsStatusesAsync()

Operation getDeviceSwitchPortsStatusesAsync


    public
                getDeviceSwitchPortsStatusesAsync(string $serial[, string $t0 = null ][, float $timespan = null ]) : PromiseInterface

Return the status for all the ports of a switch

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)

Tags

Return values

PromiseInterface —

getDeviceSwitchPortsStatusesAsyncWithHttpInfo()

Operation getDeviceSwitchPortsStatusesAsyncWithHttpInfo


    public
                getDeviceSwitchPortsStatusesAsyncWithHttpInfo(string $serial[, string $t0 = null ][, float $timespan = null ]) : PromiseInterface

Return the status for all the ports of a switch

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)

Tags

Return values

PromiseInterface —

getDeviceSwitchPortsStatusesPackets()

Operation getDeviceSwitchPortsStatusesPackets


    public
                getDeviceSwitchPortsStatusesPackets(string $serial[, string $t0 = null ][, float $timespan = null ]) : object

Return the packet counters for all the ports of a switch

Parameters

$serial : string: serial (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 1 day from today. (optional)
$timespan : float = null: 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 1 day. The default is 1 day. (optional)

Tags

Return values

object —

getDeviceSwitchPortsStatusesPacketsAsync()

Operation getDeviceSwitchPortsStatusesPacketsAsync


    public
                getDeviceSwitchPortsStatusesPacketsAsync(string $serial[, string $t0 = null ][, float $timespan = null ]) : PromiseInterface

Return the packet counters for all the ports of a switch

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 1 day from today. (optional)
$timespan : float = null: 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 1 day. The default is 1 day. (optional)

Tags

Return values

PromiseInterface —

getDeviceSwitchPortsStatusesPacketsAsyncWithHttpInfo()

Operation getDeviceSwitchPortsStatusesPacketsAsyncWithHttpInfo


    public
                getDeviceSwitchPortsStatusesPacketsAsyncWithHttpInfo(string $serial[, string $t0 = null ][, float $timespan = null ]) : PromiseInterface

Return the packet counters for all the ports of a switch

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 1 day from today. (optional)
$timespan : float = null: 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 1 day. The default is 1 day. (optional)

Tags

Return values

PromiseInterface —

getDeviceSwitchPortsStatusesPacketsWithHttpInfo()

Operation getDeviceSwitchPortsStatusesPacketsWithHttpInfo


    public
                getDeviceSwitchPortsStatusesPacketsWithHttpInfo(string $serial[, string $t0 = null ][, float $timespan = null ]) : array<string|int, mixed>

Return the packet counters for all the ports of a switch

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 1 day from today. (optional)
$timespan : float = null: 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 1 day. The default is 1 day. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceSwitchPortsStatusesWithHttpInfo()

Operation getDeviceSwitchPortsStatusesWithHttpInfo


    public
                getDeviceSwitchPortsStatusesWithHttpInfo(string $serial[, string $t0 = null ][, float $timespan = null ]) : array<string|int, mixed>

Return the status for all the ports of a switch

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceWirelessConnectionStats()

Operation getDeviceWirelessConnectionStats


    public
                getDeviceWirelessConnectionStats(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : object

Aggregated connectivity info for a given AP on this network

Parameters

$serial : string: serial (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

object —

getDeviceWirelessConnectionStatsAsync()

Operation getDeviceWirelessConnectionStatsAsync


    public
                getDeviceWirelessConnectionStatsAsync(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : PromiseInterface

Aggregated connectivity info for a given AP on this network

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

PromiseInterface —

getDeviceWirelessConnectionStatsAsyncWithHttpInfo()

Operation getDeviceWirelessConnectionStatsAsyncWithHttpInfo


    public
                getDeviceWirelessConnectionStatsAsyncWithHttpInfo(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : PromiseInterface

Aggregated connectivity info for a given AP on this network

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

PromiseInterface —

getDeviceWirelessConnectionStatsWithHttpInfo()

Operation getDeviceWirelessConnectionStatsWithHttpInfo


    public
                getDeviceWirelessConnectionStatsWithHttpInfo(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : array<string|int, mixed>

Aggregated connectivity info for a given AP on this network

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceWirelessLatencyStats()

Operation getDeviceWirelessLatencyStats


    public
                getDeviceWirelessLatencyStats(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : object

Aggregated latency info for a given AP on this network

Parameters

$serial : string: serial (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

object —

getDeviceWirelessLatencyStatsAsync()

Operation getDeviceWirelessLatencyStatsAsync


    public
                getDeviceWirelessLatencyStatsAsync(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for a given AP on this network

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getDeviceWirelessLatencyStatsAsyncWithHttpInfo()

Operation getDeviceWirelessLatencyStatsAsyncWithHttpInfo


    public
                getDeviceWirelessLatencyStatsAsyncWithHttpInfo(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for a given AP on this network

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getDeviceWirelessLatencyStatsWithHttpInfo()

Operation getDeviceWirelessLatencyStatsWithHttpInfo


    public
                getDeviceWirelessLatencyStatsWithHttpInfo(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : array<string|int, mixed>

Aggregated latency info for a given AP on this network

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceWirelessStatus()

Operation getDeviceWirelessStatus


    public
                getDeviceWirelessStatus(string $serial) : object

Return the SSID statuses of an access point

Parameters

$serial : string: serial (required)

Tags

Return values

object —

getDeviceWirelessStatusAsync()

Operation getDeviceWirelessStatusAsync


    public
                getDeviceWirelessStatusAsync(string $serial) : PromiseInterface

Return the SSID statuses of an access point

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceWirelessStatusAsyncWithHttpInfo()

Operation getDeviceWirelessStatusAsyncWithHttpInfo


    public
                getDeviceWirelessStatusAsyncWithHttpInfo(string $serial) : PromiseInterface

Return the SSID statuses of an access point

Parameters

$serial : string: (required)

Tags

Return values

PromiseInterface —

getDeviceWirelessStatusWithHttpInfo()

Operation getDeviceWirelessStatusWithHttpInfo


    public
                getDeviceWirelessStatusWithHttpInfo(string $serial) : array<string|int, mixed>

Return the SSID statuses of an access point

Parameters

$serial : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkApplianceClientSecurityEvents()

Operation getNetworkApplianceClientSecurityEvents


    public
                getNetworkApplianceClientSecurityEvents(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : object

List the security events for a client

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

object —

getNetworkApplianceClientSecurityEventsAsync()

Operation getNetworkApplianceClientSecurityEventsAsync


    public
                getNetworkApplianceClientSecurityEventsAsync(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : PromiseInterface

List the security events for a client

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

PromiseInterface —

getNetworkApplianceClientSecurityEventsAsyncWithHttpInfo()

Operation getNetworkApplianceClientSecurityEventsAsyncWithHttpInfo


    public
                getNetworkApplianceClientSecurityEventsAsyncWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : PromiseInterface

List the security events for a client

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

PromiseInterface —

getNetworkApplianceClientSecurityEventsWithHttpInfo()

Operation getNetworkApplianceClientSecurityEventsWithHttpInfo


    public
                getNetworkApplianceClientSecurityEventsWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : array<string|int, mixed>

List the security events for a client

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkApplianceSecurityEvents()

Operation getNetworkApplianceSecurityEvents


    public
                getNetworkApplianceSecurityEvents(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : object

List the security events for a network

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

object —

getNetworkApplianceSecurityEventsAsync()

Operation getNetworkApplianceSecurityEventsAsync


    public
                getNetworkApplianceSecurityEventsAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : PromiseInterface

List the security events for a network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

PromiseInterface —

getNetworkApplianceSecurityEventsAsyncWithHttpInfo()

Operation getNetworkApplianceSecurityEventsAsyncWithHttpInfo


    public
                getNetworkApplianceSecurityEventsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : PromiseInterface

List the security events for a network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

PromiseInterface —

getNetworkApplianceSecurityEventsWithHttpInfo()

Operation getNetworkApplianceSecurityEventsWithHttpInfo


    public
                getNetworkApplianceSecurityEventsWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : array<string|int, mixed>

List the security events for a network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkBluetoothClient()

Operation getNetworkBluetoothClient


    public
                getNetworkBluetoothClient(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : object

Return a Bluetooth client

Parameters

$network_id : string: network_id (required)
$bluetooth_client_id : string: bluetooth_client_id (required)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)
$connectivity_history_timespan : int = null: The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)

Tags

Return values

object —

getNetworkBluetoothClientAsync()

Operation getNetworkBluetoothClientAsync


    public
                getNetworkBluetoothClientAsync(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : PromiseInterface

Return a Bluetooth client

Parameters

$network_id : string: (required)
$bluetooth_client_id : string: (required)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)
$connectivity_history_timespan : int = null: The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)

Tags

Return values

PromiseInterface —

getNetworkBluetoothClientAsyncWithHttpInfo()

Operation getNetworkBluetoothClientAsyncWithHttpInfo


    public
                getNetworkBluetoothClientAsyncWithHttpInfo(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : PromiseInterface

Return a Bluetooth client

Parameters

$network_id : string: (required)
$bluetooth_client_id : string: (required)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)
$connectivity_history_timespan : int = null: The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)

Tags

Return values

PromiseInterface —

getNetworkBluetoothClients()

Operation getNetworkBluetoothClients


    public
                getNetworkBluetoothClients(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : object

List the Bluetooth clients seen by APs in this network

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$timespan : float = null: 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 7 days. The default is 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)

Tags

Return values

object —

getNetworkBluetoothClientsAsync()

Operation getNetworkBluetoothClientsAsync


    public
                getNetworkBluetoothClientsAsync(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : PromiseInterface

List the Bluetooth clients seen by APs in this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$timespan : float = null: 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 7 days. The default is 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)

Tags

Return values

PromiseInterface —

getNetworkBluetoothClientsAsyncWithHttpInfo()

Operation getNetworkBluetoothClientsAsyncWithHttpInfo


    public
                getNetworkBluetoothClientsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : PromiseInterface

List the Bluetooth clients seen by APs in this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$timespan : float = null: 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 7 days. The default is 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)

Tags

Return values

PromiseInterface —

getNetworkBluetoothClientsWithHttpInfo()

Operation getNetworkBluetoothClientsWithHttpInfo


    public
                getNetworkBluetoothClientsWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : array<string|int, mixed>

List the Bluetooth clients seen by APs in this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$timespan : float = null: 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 7 days. The default is 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkBluetoothClientWithHttpInfo()

Operation getNetworkBluetoothClientWithHttpInfo


    public
                getNetworkBluetoothClientWithHttpInfo(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : array<string|int, mixed>

Return a Bluetooth client

Parameters

$network_id : string: (required)
$bluetooth_client_id : string: (required)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)
$connectivity_history_timespan : int = null: The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClient()

Operation getNetworkClient


    public
                getNetworkClient(string $network_id, string $client_id) : object

Return the client associated with the given identifier

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)

Tags

Return values

object —

getNetworkClientAsync()

Operation getNetworkClientAsync


    public
                getNetworkClientAsync(string $network_id, string $client_id) : PromiseInterface

Return the client associated with the given identifier

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkClientAsyncWithHttpInfo()

Operation getNetworkClientAsyncWithHttpInfo


    public
                getNetworkClientAsyncWithHttpInfo(string $network_id, string $client_id) : PromiseInterface

Return the client associated with the given identifier

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkClients()

Operation getNetworkClients


    public
                getNetworkClients(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $statuses = null ][, string $ip = null ][, string $ip6 = null ][, string $ip6_local = null ][, string $mac = null ][, string $os = null ][, string $description = null ][, array<string|int, string> $recent_device_connections = null ]) : object

List the clients that have used this network in the timespan

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$statuses : array<string|int, string> = null: Filters clients based on status. Can be one of 'Online' or 'Offline'. (optional)
$ip : string = null: Filters clients based on a partial or full match for the ip address field. (optional)
$ip6 : string = null: Filters clients based on a partial or full match for the ip6 address field. (optional)
$ip6_local : string = null: Filters clients based on a partial or full match for the ip6Local address field. (optional)
$mac : string = null: Filters clients based on a partial or full match for the mac address field. (optional)
$os : string = null: Filters clients based on a partial or full match for the os (operating system) field. (optional)
$description : string = null: Filters clients based on a partial or full match for the description field. (optional)
$recent_device_connections : array<string|int, string> = null: Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'. (optional)

Tags

Return values

object —

getNetworkClientsApplicationUsage()

Operation getNetworkClientsApplicationUsage


    public
                getNetworkClientsApplicationUsage(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : object

Return the application usage data for clients

Parameters

$network_id : string: network_id (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, eveusage histories application usagents for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

object —

getNetworkClientsApplicationUsageAsync()

Operation getNetworkClientsApplicationUsageAsync


    public
                getNetworkClientsApplicationUsageAsync(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface

Return the application usage data for clients

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, eveusage histories application usagents for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsApplicationUsageAsyncWithHttpInfo()

Operation getNetworkClientsApplicationUsageAsyncWithHttpInfo


    public
                getNetworkClientsApplicationUsageAsyncWithHttpInfo(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface

Return the application usage data for clients

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, eveusage histories application usagents for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsApplicationUsageWithHttpInfo()

Operation getNetworkClientsApplicationUsageWithHttpInfo


    public
                getNetworkClientsApplicationUsageWithHttpInfo(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : array<string|int, mixed>

Return the application usage data for clients

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, eveusage histories application usagents for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClientsAsync()

Operation getNetworkClientsAsync


    public
                getNetworkClientsAsync(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $statuses = null ][, string $ip = null ][, string $ip6 = null ][, string $ip6_local = null ][, string $mac = null ][, string $os = null ][, string $description = null ][, array<string|int, string> $recent_device_connections = null ]) : PromiseInterface

List the clients that have used this network in the timespan

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$statuses : array<string|int, string> = null: Filters clients based on status. Can be one of 'Online' or 'Offline'. (optional)
$ip : string = null: Filters clients based on a partial or full match for the ip address field. (optional)
$ip6 : string = null: Filters clients based on a partial or full match for the ip6 address field. (optional)
$ip6_local : string = null: Filters clients based on a partial or full match for the ip6Local address field. (optional)
$mac : string = null: Filters clients based on a partial or full match for the mac address field. (optional)
$os : string = null: Filters clients based on a partial or full match for the os (operating system) field. (optional)
$description : string = null: Filters clients based on a partial or full match for the description field. (optional)
$recent_device_connections : array<string|int, string> = null: Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsAsyncWithHttpInfo()

Operation getNetworkClientsAsyncWithHttpInfo


    public
                getNetworkClientsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $statuses = null ][, string $ip = null ][, string $ip6 = null ][, string $ip6_local = null ][, string $mac = null ][, string $os = null ][, string $description = null ][, array<string|int, string> $recent_device_connections = null ]) : PromiseInterface

List the clients that have used this network in the timespan

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$statuses : array<string|int, string> = null: Filters clients based on status. Can be one of 'Online' or 'Offline'. (optional)
$ip : string = null: Filters clients based on a partial or full match for the ip address field. (optional)
$ip6 : string = null: Filters clients based on a partial or full match for the ip6 address field. (optional)
$ip6_local : string = null: Filters clients based on a partial or full match for the ip6Local address field. (optional)
$mac : string = null: Filters clients based on a partial or full match for the mac address field. (optional)
$os : string = null: Filters clients based on a partial or full match for the os (operating system) field. (optional)
$description : string = null: Filters clients based on a partial or full match for the description field. (optional)
$recent_device_connections : array<string|int, string> = null: Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsOverview()

Operation getNetworkClientsOverview


    public
                getNetworkClientsOverview(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : object

Return overview statistics for network clients

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)

Tags

Return values

object —

getNetworkClientsOverviewAsync()

Operation getNetworkClientsOverviewAsync


    public
                getNetworkClientsOverviewAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : PromiseInterface

Return overview statistics for network clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsOverviewAsyncWithHttpInfo()

Operation getNetworkClientsOverviewAsyncWithHttpInfo


    public
                getNetworkClientsOverviewAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : PromiseInterface

Return overview statistics for network clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsOverviewWithHttpInfo()

Operation getNetworkClientsOverviewWithHttpInfo


    public
                getNetworkClientsOverviewWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : array<string|int, mixed>

Return overview statistics for network clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClientsUsageHistories()

Operation getNetworkClientsUsageHistories


    public
                getNetworkClientsUsageHistories(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : object

Return the usage histories for clients

Parameters

$network_id : string: network_id (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

object —

getNetworkClientsUsageHistoriesAsync()

Operation getNetworkClientsUsageHistoriesAsync


    public
                getNetworkClientsUsageHistoriesAsync(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface

Return the usage histories for clients

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsUsageHistoriesAsyncWithHttpInfo()

Operation getNetworkClientsUsageHistoriesAsyncWithHttpInfo


    public
                getNetworkClientsUsageHistoriesAsyncWithHttpInfo(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface

Return the usage histories for clients

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientsUsageHistoriesWithHttpInfo()

Operation getNetworkClientsUsageHistoriesWithHttpInfo


    public
                getNetworkClientsUsageHistoriesWithHttpInfo(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : array<string|int, mixed>

Return the usage histories for clients

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClientsWithHttpInfo()

Operation getNetworkClientsWithHttpInfo


    public
                getNetworkClientsWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $statuses = null ][, string $ip = null ][, string $ip6 = null ][, string $ip6_local = null ][, string $mac = null ][, string $os = null ][, string $description = null ][, array<string|int, string> $recent_device_connections = null ]) : array<string|int, mixed>

List the clients that have used this network in the timespan

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$statuses : array<string|int, string> = null: Filters clients based on status. Can be one of 'Online' or 'Offline'. (optional)
$ip : string = null: Filters clients based on a partial or full match for the ip address field. (optional)
$ip6 : string = null: Filters clients based on a partial or full match for the ip6 address field. (optional)
$ip6_local : string = null: Filters clients based on a partial or full match for the ip6Local address field. (optional)
$mac : string = null: Filters clients based on a partial or full match for the mac address field. (optional)
$os : string = null: Filters clients based on a partial or full match for the os (operating system) field. (optional)
$description : string = null: Filters clients based on a partial or full match for the description field. (optional)
$recent_device_connections : array<string|int, string> = null: Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClientTrafficHistory()

Operation getNetworkClientTrafficHistory


    public
                getNetworkClientTrafficHistory(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

Return the client's network traffic data over time

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

object —

getNetworkClientTrafficHistoryAsync()

Operation getNetworkClientTrafficHistoryAsync


    public
                getNetworkClientTrafficHistoryAsync(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return the client's network traffic data over time

Parameters

$network_id : string: (required)
$client_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientTrafficHistoryAsyncWithHttpInfo()

Operation getNetworkClientTrafficHistoryAsyncWithHttpInfo


    public
                getNetworkClientTrafficHistoryAsyncWithHttpInfo(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return the client's network traffic data over time

Parameters

$network_id : string: (required)
$client_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkClientTrafficHistoryWithHttpInfo()

Operation getNetworkClientTrafficHistoryWithHttpInfo


    public
                getNetworkClientTrafficHistoryWithHttpInfo(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

Return the client's network traffic data over time

Parameters

$network_id : string: (required)
$client_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClientUsageHistory()

Operation getNetworkClientUsageHistory


    public
                getNetworkClientUsageHistory(string $network_id, string $client_id) : object

Return the client's daily usage history

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)

Tags

Return values

object —

getNetworkClientUsageHistoryAsync()

Operation getNetworkClientUsageHistoryAsync


    public
                getNetworkClientUsageHistoryAsync(string $network_id, string $client_id) : PromiseInterface

Return the client's daily usage history

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkClientUsageHistoryAsyncWithHttpInfo()

Operation getNetworkClientUsageHistoryAsyncWithHttpInfo


    public
                getNetworkClientUsageHistoryAsyncWithHttpInfo(string $network_id, string $client_id) : PromiseInterface

Return the client's daily usage history

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkClientUsageHistoryWithHttpInfo()

Operation getNetworkClientUsageHistoryWithHttpInfo


    public
                getNetworkClientUsageHistoryWithHttpInfo(string $network_id, string $client_id) : array<string|int, mixed>

Return the client's daily usage history

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkClientWithHttpInfo()

Operation getNetworkClientWithHttpInfo


    public
                getNetworkClientWithHttpInfo(string $network_id, string $client_id) : array<string|int, mixed>

Return the client associated with the given identifier

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkEvents()

Operation getNetworkEvents


    public
                getNetworkEvents(string $network_id[, string $product_type = null ][, array<string|int, string> $included_event_types = null ][, array<string|int, string> $excluded_event_types = null ][, string $device_mac = null ][, string $device_serial = null ][, string $device_name = null ][, string $client_ip = null ][, string $client_mac = null ][, string $client_name = null ][, string $sm_device_mac = null ][, string $sm_device_name = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

List the events for the network

Parameters

$network_id : string: network_id (required)
$product_type : string = null: The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and environmental (optional)
$included_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to only include events with these types. (optional)
$excluded_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to exclude events with these types. (optional)
$device_mac : string = null: The MAC address of the Meraki device which the list of events will be filtered with (optional)
$device_serial : string = null: The serial of the Meraki device which the list of events will be filtered with (optional)
$device_name : string = null: The name of the Meraki device which the list of events will be filtered with (optional)
$client_ip : string = null: The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks. (optional)
$client_mac : string = null: The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks. (optional)
$client_name : string = null: The name, or partial name, of the client which the list of events will be filtered with (optional)
$sm_device_mac : string = null: The MAC address of the Systems Manager device which the list of events will be filtered with (optional)
$sm_device_name : string = null: The name of the Systems Manager device which the list of events will be filtered with (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

object —

getNetworkEventsAsync()

Operation getNetworkEventsAsync


    public
                getNetworkEventsAsync(string $network_id[, string $product_type = null ][, array<string|int, string> $included_event_types = null ][, array<string|int, string> $excluded_event_types = null ][, string $device_mac = null ][, string $device_serial = null ][, string $device_name = null ][, string $client_ip = null ][, string $client_mac = null ][, string $client_name = null ][, string $sm_device_mac = null ][, string $sm_device_name = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

List the events for the network

Parameters

$network_id : string: (required)
$product_type : string = null: The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and environmental (optional)
$included_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to only include events with these types. (optional)
$excluded_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to exclude events with these types. (optional)
$device_mac : string = null: The MAC address of the Meraki device which the list of events will be filtered with (optional)
$device_serial : string = null: The serial of the Meraki device which the list of events will be filtered with (optional)
$device_name : string = null: The name of the Meraki device which the list of events will be filtered with (optional)
$client_ip : string = null: The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks. (optional)
$client_mac : string = null: The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks. (optional)
$client_name : string = null: The name, or partial name, of the client which the list of events will be filtered with (optional)
$sm_device_mac : string = null: The MAC address of the Systems Manager device which the list of events will be filtered with (optional)
$sm_device_name : string = null: The name of the Systems Manager device which the list of events will be filtered with (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkEventsAsyncWithHttpInfo()

Operation getNetworkEventsAsyncWithHttpInfo


    public
                getNetworkEventsAsyncWithHttpInfo(string $network_id[, string $product_type = null ][, array<string|int, string> $included_event_types = null ][, array<string|int, string> $excluded_event_types = null ][, string $device_mac = null ][, string $device_serial = null ][, string $device_name = null ][, string $client_ip = null ][, string $client_mac = null ][, string $client_name = null ][, string $sm_device_mac = null ][, string $sm_device_name = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

List the events for the network

Parameters

$network_id : string: (required)
$product_type : string = null: The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and environmental (optional)
$included_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to only include events with these types. (optional)
$excluded_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to exclude events with these types. (optional)
$device_mac : string = null: The MAC address of the Meraki device which the list of events will be filtered with (optional)
$device_serial : string = null: The serial of the Meraki device which the list of events will be filtered with (optional)
$device_name : string = null: The name of the Meraki device which the list of events will be filtered with (optional)
$client_ip : string = null: The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks. (optional)
$client_mac : string = null: The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks. (optional)
$client_name : string = null: The name, or partial name, of the client which the list of events will be filtered with (optional)
$sm_device_mac : string = null: The MAC address of the Systems Manager device which the list of events will be filtered with (optional)
$sm_device_name : string = null: The name of the Systems Manager device which the list of events will be filtered with (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkEventsEventTypes()

Operation getNetworkEventsEventTypes


    public
                getNetworkEventsEventTypes(string $network_id) : object

List the event type to human-readable description

Parameters

$network_id : string: network_id (required)

Tags

Return values

object —

getNetworkEventsEventTypesAsync()

Operation getNetworkEventsEventTypesAsync


    public
                getNetworkEventsEventTypesAsync(string $network_id) : PromiseInterface

List the event type to human-readable description

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkEventsEventTypesAsyncWithHttpInfo()

Operation getNetworkEventsEventTypesAsyncWithHttpInfo


    public
                getNetworkEventsEventTypesAsyncWithHttpInfo(string $network_id) : PromiseInterface

List the event type to human-readable description

Parameters

$network_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkEventsEventTypesWithHttpInfo()

Operation getNetworkEventsEventTypesWithHttpInfo


    public
                getNetworkEventsEventTypesWithHttpInfo(string $network_id) : array<string|int, mixed>

List the event type to human-readable description

Parameters

$network_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkEventsWithHttpInfo()

Operation getNetworkEventsWithHttpInfo


    public
                getNetworkEventsWithHttpInfo(string $network_id[, string $product_type = null ][, array<string|int, string> $included_event_types = null ][, array<string|int, string> $excluded_event_types = null ][, string $device_mac = null ][, string $device_serial = null ][, string $device_name = null ][, string $client_ip = null ][, string $client_mac = null ][, string $client_name = null ][, string $sm_device_mac = null ][, string $sm_device_name = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

List the events for the network

Parameters

$network_id : string: (required)
$product_type : string = null: The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and environmental (optional)
$included_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to only include events with these types. (optional)
$excluded_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to exclude events with these types. (optional)
$device_mac : string = null: The MAC address of the Meraki device which the list of events will be filtered with (optional)
$device_serial : string = null: The serial of the Meraki device which the list of events will be filtered with (optional)
$device_name : string = null: The name of the Meraki device which the list of events will be filtered with (optional)
$client_ip : string = null: The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks. (optional)
$client_mac : string = null: The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks. (optional)
$client_name : string = null: The name, or partial name, of the client which the list of events will be filtered with (optional)
$sm_device_mac : string = null: The MAC address of the Systems Manager device which the list of events will be filtered with (optional)
$sm_device_name : string = null: The name of the Systems Manager device which the list of events will be filtered with (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkInsightApplicationHealthByTime()

Operation getNetworkInsightApplicationHealthByTime


    public
                getNetworkInsightApplicationHealthByTime(string $network_id, string $application_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : object

Get application health by time

Parameters

$network_id : string: network_id (required)
$application_id : string: application_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. The default is 2 hours. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60, 300, 3600, 86400. The default is 300. (optional)

Tags

Return values

object —

getNetworkInsightApplicationHealthByTimeAsync()

Operation getNetworkInsightApplicationHealthByTimeAsync


    public
                getNetworkInsightApplicationHealthByTimeAsync(string $network_id, string $application_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : PromiseInterface

Get application health by time

Parameters

$network_id : string: (required)
$application_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. The default is 2 hours. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60, 300, 3600, 86400. The default is 300. (optional)

Tags

Return values

PromiseInterface —

getNetworkInsightApplicationHealthByTimeAsyncWithHttpInfo()

Operation getNetworkInsightApplicationHealthByTimeAsyncWithHttpInfo


    public
                getNetworkInsightApplicationHealthByTimeAsyncWithHttpInfo(string $network_id, string $application_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : PromiseInterface

Get application health by time

Parameters

$network_id : string: (required)
$application_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. The default is 2 hours. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60, 300, 3600, 86400. The default is 300. (optional)

Tags

Return values

PromiseInterface —

getNetworkInsightApplicationHealthByTimeWithHttpInfo()

Operation getNetworkInsightApplicationHealthByTimeWithHttpInfo


    public
                getNetworkInsightApplicationHealthByTimeWithHttpInfo(string $network_id, string $application_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : array<string|int, mixed>

Get application health by time

Parameters

$network_id : string: (required)
$application_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. The default is 2 hours. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60, 300, 3600, 86400. The default is 300. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkNetworkHealthChannelUtilization()

Operation getNetworkNetworkHealthChannelUtilization


    public
                getNetworkNetworkHealthChannelUtilization(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

Get the channel utilization over each radio for all APs in a network.

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

object —

getNetworkNetworkHealthChannelUtilizationAsync()

Operation getNetworkNetworkHealthChannelUtilizationAsync


    public
                getNetworkNetworkHealthChannelUtilizationAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Get the channel utilization over each radio for all APs in a network.

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkNetworkHealthChannelUtilizationAsyncWithHttpInfo()

Operation getNetworkNetworkHealthChannelUtilizationAsyncWithHttpInfo


    public
                getNetworkNetworkHealthChannelUtilizationAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Get the channel utilization over each radio for all APs in a network.

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkNetworkHealthChannelUtilizationWithHttpInfo()

Operation getNetworkNetworkHealthChannelUtilizationWithHttpInfo


    public
                getNetworkNetworkHealthChannelUtilizationWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

Get the channel utilization over each radio for all APs in a network.

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkSmDeviceCellularUsageHistory()

Operation getNetworkSmDeviceCellularUsageHistory


    public
                getNetworkSmDeviceCellularUsageHistory(string $network_id, string $device_id) : object

Return the client's daily cellular data usage history

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)

Tags

Return values

object —

getNetworkSmDeviceCellularUsageHistoryAsync()

Operation getNetworkSmDeviceCellularUsageHistoryAsync


    public
                getNetworkSmDeviceCellularUsageHistoryAsync(string $network_id, string $device_id) : PromiseInterface

Return the client's daily cellular data usage history

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceCellularUsageHistoryAsyncWithHttpInfo()

Operation getNetworkSmDeviceCellularUsageHistoryAsyncWithHttpInfo


    public
                getNetworkSmDeviceCellularUsageHistoryAsyncWithHttpInfo(string $network_id, string $device_id) : PromiseInterface

Return the client's daily cellular data usage history

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceCellularUsageHistoryWithHttpInfo()

Operation getNetworkSmDeviceCellularUsageHistoryWithHttpInfo


    public
                getNetworkSmDeviceCellularUsageHistoryWithHttpInfo(string $network_id, string $device_id) : array<string|int, mixed>

Return the client's daily cellular data usage history

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkSmDeviceConnectivity()

Operation getNetworkSmDeviceConnectivity


    public
                getNetworkSmDeviceConnectivity(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

Returns historical connectivity data (whether a device is regularly checking in to Dashboard).

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

object —

getNetworkSmDeviceConnectivityAsync()

Operation getNetworkSmDeviceConnectivityAsync


    public
                getNetworkSmDeviceConnectivityAsync(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Returns historical connectivity data (whether a device is regularly checking in to Dashboard).

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceConnectivityAsyncWithHttpInfo()

Operation getNetworkSmDeviceConnectivityAsyncWithHttpInfo


    public
                getNetworkSmDeviceConnectivityAsyncWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Returns historical connectivity data (whether a device is regularly checking in to Dashboard).

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceConnectivityWithHttpInfo()

Operation getNetworkSmDeviceConnectivityWithHttpInfo


    public
                getNetworkSmDeviceConnectivityWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

Returns historical connectivity data (whether a device is regularly checking in to Dashboard).

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkSmDeviceDesktopLogs()

Operation getNetworkSmDeviceDesktopLogs


    public
                getNetworkSmDeviceDesktopLogs(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

Return historical records of various Systems Manager network connection details for desktop devices.

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

object —

getNetworkSmDeviceDesktopLogsAsync()

Operation getNetworkSmDeviceDesktopLogsAsync


    public
                getNetworkSmDeviceDesktopLogsAsync(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return historical records of various Systems Manager network connection details for desktop devices.

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceDesktopLogsAsyncWithHttpInfo()

Operation getNetworkSmDeviceDesktopLogsAsyncWithHttpInfo


    public
                getNetworkSmDeviceDesktopLogsAsyncWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return historical records of various Systems Manager network connection details for desktop devices.

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceDesktopLogsWithHttpInfo()

Operation getNetworkSmDeviceDesktopLogsWithHttpInfo


    public
                getNetworkSmDeviceDesktopLogsWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

Return historical records of various Systems Manager network connection details for desktop devices.

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkSmDeviceDeviceCommandLogs()

Operation getNetworkSmDeviceDeviceCommandLogs


    public
                getNetworkSmDeviceDeviceCommandLogs(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

Return historical records of commands sent to Systems Manager devices

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

object —

getNetworkSmDeviceDeviceCommandLogsAsync()

Operation getNetworkSmDeviceDeviceCommandLogsAsync


    public
                getNetworkSmDeviceDeviceCommandLogsAsync(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return historical records of commands sent to Systems Manager devices

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceDeviceCommandLogsAsyncWithHttpInfo()

Operation getNetworkSmDeviceDeviceCommandLogsAsyncWithHttpInfo


    public
                getNetworkSmDeviceDeviceCommandLogsAsyncWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return historical records of commands sent to Systems Manager devices

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkSmDeviceDeviceCommandLogsWithHttpInfo()

Operation getNetworkSmDeviceDeviceCommandLogsWithHttpInfo


    public
                getNetworkSmDeviceDeviceCommandLogsWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

Return historical records of commands sent to Systems Manager devices

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkSmDevicePerformanceHistory()

Operation getNetworkSmDevicePerformanceHistory


    public
                getNetworkSmDevicePerformanceHistory(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

Return historical records of various Systems Manager client metrics for desktop devices.

Parameters

$network_id : string: network_id (required)
$device_id : string: device_id (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

object —

getNetworkSmDevicePerformanceHistoryAsync()

Operation getNetworkSmDevicePerformanceHistoryAsync


    public
                getNetworkSmDevicePerformanceHistoryAsync(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return historical records of various Systems Manager client metrics for desktop devices.

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkSmDevicePerformanceHistoryAsyncWithHttpInfo()

Operation getNetworkSmDevicePerformanceHistoryAsyncWithHttpInfo


    public
                getNetworkSmDevicePerformanceHistoryAsyncWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

Return historical records of various Systems Manager client metrics for desktop devices.

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkSmDevicePerformanceHistoryWithHttpInfo()

Operation getNetworkSmDevicePerformanceHistoryWithHttpInfo


    public
                getNetworkSmDevicePerformanceHistoryWithHttpInfo(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

Return historical records of various Systems Manager client metrics for desktop devices.

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkSplashLoginAttempts()

Operation getNetworkSplashLoginAttempts


    public
                getNetworkSplashLoginAttempts(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : object

List the splash login attempts for a network

Parameters

$network_id : string: network_id (required)
$ssid_number : int = null: Only return the login attempts for the specified SSID (optional)
$login_identifier : string = null: The username, email, or phone number used during login (optional)
$timespan : int = null: The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)

Tags

Return values

object —

getNetworkSplashLoginAttemptsAsync()

Operation getNetworkSplashLoginAttemptsAsync


    public
                getNetworkSplashLoginAttemptsAsync(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : PromiseInterface

List the splash login attempts for a network

Parameters

$network_id : string: (required)
$ssid_number : int = null: Only return the login attempts for the specified SSID (optional)
$login_identifier : string = null: The username, email, or phone number used during login (optional)
$timespan : int = null: The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)

Tags

Return values

PromiseInterface —

getNetworkSplashLoginAttemptsAsyncWithHttpInfo()

Operation getNetworkSplashLoginAttemptsAsyncWithHttpInfo


    public
                getNetworkSplashLoginAttemptsAsyncWithHttpInfo(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : PromiseInterface

List the splash login attempts for a network

Parameters

$network_id : string: (required)
$ssid_number : int = null: Only return the login attempts for the specified SSID (optional)
$login_identifier : string = null: The username, email, or phone number used during login (optional)
$timespan : int = null: The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)

Tags

Return values

PromiseInterface —

getNetworkSplashLoginAttemptsWithHttpInfo()

Operation getNetworkSplashLoginAttemptsWithHttpInfo


    public
                getNetworkSplashLoginAttemptsWithHttpInfo(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : array<string|int, mixed>

List the splash login attempts for a network

Parameters

$network_id : string: (required)
$ssid_number : int = null: Only return the login attempts for the specified SSID (optional)
$login_identifier : string = null: The username, email, or phone number used during login (optional)
$timespan : int = null: The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkTraffic()

Operation getNetworkTraffic


    public
                getNetworkTraffic(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : object

Return the traffic analysis data for this network

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
$timespan : float = null: 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 30 days. (optional)
$device_type : string = null: Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (optional)

Tags

Return values

object —

getNetworkTrafficAsync()

Operation getNetworkTrafficAsync


    public
                getNetworkTrafficAsync(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : PromiseInterface

Return the traffic analysis data for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
$timespan : float = null: 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 30 days. (optional)
$device_type : string = null: Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (optional)

Tags

Return values

PromiseInterface —

getNetworkTrafficAsyncWithHttpInfo()

Operation getNetworkTrafficAsyncWithHttpInfo


    public
                getNetworkTrafficAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : PromiseInterface

Return the traffic analysis data for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
$timespan : float = null: 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 30 days. (optional)
$device_type : string = null: Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (optional)

Tags

Return values

PromiseInterface —

getNetworkTrafficWithHttpInfo()

Operation getNetworkTrafficWithHttpInfo


    public
                getNetworkTrafficWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : array<string|int, mixed>

Return the traffic analysis data for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
$timespan : float = null: 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 30 days. (optional)
$device_type : string = null: Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessAirMarshal()

Operation getNetworkWirelessAirMarshal


    public
                getNetworkWirelessAirMarshal(string $network_id[, string $t0 = null ][, float $timespan = null ]) : object

List Air Marshal scan results from a network

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

object —

getNetworkWirelessAirMarshalAsync()

Operation getNetworkWirelessAirMarshalAsync


    public
                getNetworkWirelessAirMarshalAsync(string $network_id[, string $t0 = null ][, float $timespan = null ]) : PromiseInterface

List Air Marshal scan results from a network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessAirMarshalAsyncWithHttpInfo()

Operation getNetworkWirelessAirMarshalAsyncWithHttpInfo


    public
                getNetworkWirelessAirMarshalAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ]) : PromiseInterface

List Air Marshal scan results from a network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessAirMarshalWithHttpInfo()

Operation getNetworkWirelessAirMarshalWithHttpInfo


    public
                getNetworkWirelessAirMarshalWithHttpInfo(string $network_id[, string $t0 = null ][, float $timespan = null ]) : array<string|int, mixed>

List Air Marshal scan results from a network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessChannelUtilizationHistory()

Operation getNetworkWirelessChannelUtilizationHistory


    public
                getNetworkWirelessChannelUtilizationHistory(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ]) : object

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

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified. (optional)
$ap_tag : string = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)

Tags

Return values

object —

getNetworkWirelessChannelUtilizationHistoryAsync()

Operation getNetworkWirelessChannelUtilizationHistoryAsync


    public
                getNetworkWirelessChannelUtilizationHistoryAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ]) : PromiseInterface

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified. (optional)
$ap_tag : string = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessChannelUtilizationHistoryAsyncWithHttpInfo()

Operation getNetworkWirelessChannelUtilizationHistoryAsyncWithHttpInfo


    public
                getNetworkWirelessChannelUtilizationHistoryAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ]) : PromiseInterface

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified. (optional)
$ap_tag : string = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessChannelUtilizationHistoryWithHttpInfo()

Operation getNetworkWirelessChannelUtilizationHistoryWithHttpInfo


    public
                getNetworkWirelessChannelUtilizationHistoryWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ]) : array<string|int, mixed>

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified. (optional)
$ap_tag : string = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessClientConnectionStats()

Operation getNetworkWirelessClientConnectionStats


    public
                getNetworkWirelessClientConnectionStats(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : object

Aggregated connectivity info for a given client on this network

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

object —

getNetworkWirelessClientConnectionStatsAsync()

Operation getNetworkWirelessClientConnectionStatsAsync


    public
                getNetworkWirelessClientConnectionStatsAsync(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : PromiseInterface

Aggregated connectivity info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientConnectionStatsAsyncWithHttpInfo()

Operation getNetworkWirelessClientConnectionStatsAsyncWithHttpInfo


    public
                getNetworkWirelessClientConnectionStatsAsyncWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : PromiseInterface

Aggregated connectivity info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientConnectionStatsWithHttpInfo()

Operation getNetworkWirelessClientConnectionStatsWithHttpInfo


    public
                getNetworkWirelessClientConnectionStatsWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : array<string|int, mixed>

Aggregated connectivity info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessClientConnectivityEvents()

Operation getNetworkWirelessClientConnectivityEvents


    public
                getNetworkWirelessClientConnectivityEvents(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = null ]) : object

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

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$types : array<string|int, string> = null: 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'. (optional)
$included_severities : array<string|int, string> = null: 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'. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$device_serial : string = null: Filter results by an AP's serial number. (optional)

Tags

Return values

object —

getNetworkWirelessClientConnectivityEventsAsync()

Operation getNetworkWirelessClientConnectivityEventsAsync


    public
                getNetworkWirelessClientConnectivityEventsAsync(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = null ]) : PromiseInterface

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

Parameters

$network_id : string: (required)
$client_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$types : array<string|int, string> = null: 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'. (optional)
$included_severities : array<string|int, string> = null: 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'. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$device_serial : string = null: Filter results by an AP's serial number. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientConnectivityEventsAsyncWithHttpInfo()

Operation getNetworkWirelessClientConnectivityEventsAsyncWithHttpInfo


    public
                getNetworkWirelessClientConnectivityEventsAsyncWithHttpInfo(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = null ]) : PromiseInterface

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

Parameters

$network_id : string: (required)
$client_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$types : array<string|int, string> = null: 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'. (optional)
$included_severities : array<string|int, string> = null: 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'. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$device_serial : string = null: Filter results by an AP's serial number. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientConnectivityEventsWithHttpInfo()

Operation getNetworkWirelessClientConnectivityEventsWithHttpInfo


    public
                getNetworkWirelessClientConnectivityEventsWithHttpInfo(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = null ]) : array<string|int, mixed>

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

Parameters

$network_id : string: (required)
$client_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$types : array<string|int, string> = null: 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'. (optional)
$included_severities : array<string|int, string> = null: 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'. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$device_serial : string = null: Filter results by an AP's serial number. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessClientCountHistory()

Operation getNetworkWirelessClientCountHistory


    public
                getNetworkWirelessClientCountHistory(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : object

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

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device client counts over time inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

object —

getNetworkWirelessClientCountHistoryAsync()

Operation getNetworkWirelessClientCountHistoryAsync


    public
                getNetworkWirelessClientCountHistoryAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : PromiseInterface

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device client counts over time inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientCountHistoryAsyncWithHttpInfo()

Operation getNetworkWirelessClientCountHistoryAsyncWithHttpInfo


    public
                getNetworkWirelessClientCountHistoryAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : PromiseInterface

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device client counts over time inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientCountHistoryWithHttpInfo()

Operation getNetworkWirelessClientCountHistoryWithHttpInfo


    public
                getNetworkWirelessClientCountHistoryWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : array<string|int, mixed>

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device client counts over time inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessClientLatencyHistory()

Operation getNetworkWirelessClientLatencyHistory


    public
                getNetworkWirelessClientLatencyHistory(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : object

Return the latency history for a client

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400. (optional)

Tags

Return values

object —

getNetworkWirelessClientLatencyHistoryAsync()

Operation getNetworkWirelessClientLatencyHistoryAsync


    public
                getNetworkWirelessClientLatencyHistoryAsync(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : PromiseInterface

Return the latency history for a client

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientLatencyHistoryAsyncWithHttpInfo()

Operation getNetworkWirelessClientLatencyHistoryAsyncWithHttpInfo


    public
                getNetworkWirelessClientLatencyHistoryAsyncWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : PromiseInterface

Return the latency history for a client

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientLatencyHistoryWithHttpInfo()

Operation getNetworkWirelessClientLatencyHistoryWithHttpInfo


    public
                getNetworkWirelessClientLatencyHistoryWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : array<string|int, mixed>

Return the latency history for a client

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessClientLatencyStats()

Operation getNetworkWirelessClientLatencyStats


    public
                getNetworkWirelessClientLatencyStats(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : object

Aggregated latency info for a given client on this network

Parameters

$network_id : string: network_id (required)
$client_id : string: client_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

object —

getNetworkWirelessClientLatencyStatsAsync()

Operation getNetworkWirelessClientLatencyStatsAsync


    public
                getNetworkWirelessClientLatencyStatsAsync(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientLatencyStatsAsyncWithHttpInfo()

Operation getNetworkWirelessClientLatencyStatsAsyncWithHttpInfo


    public
                getNetworkWirelessClientLatencyStatsAsyncWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientLatencyStatsWithHttpInfo()

Operation getNetworkWirelessClientLatencyStatsWithHttpInfo


    public
                getNetworkWirelessClientLatencyStatsWithHttpInfo(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : array<string|int, mixed>

Aggregated latency info for a given client on this network

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessClientsConnectionStats()

Operation getNetworkWirelessClientsConnectionStats


    public
                getNetworkWirelessClientsConnectionStats(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : object

Aggregated connectivity info for this network, grouped by clients

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

object —

getNetworkWirelessClientsConnectionStatsAsync()

Operation getNetworkWirelessClientsConnectionStatsAsync


    public
                getNetworkWirelessClientsConnectionStatsAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : PromiseInterface

Aggregated connectivity info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientsConnectionStatsAsyncWithHttpInfo()

Operation getNetworkWirelessClientsConnectionStatsAsyncWithHttpInfo


    public
                getNetworkWirelessClientsConnectionStatsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : PromiseInterface

Aggregated connectivity info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientsConnectionStatsWithHttpInfo()

Operation getNetworkWirelessClientsConnectionStatsWithHttpInfo


    public
                getNetworkWirelessClientsConnectionStatsWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : array<string|int, mixed>

Aggregated connectivity info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessClientsLatencyStats()

Operation getNetworkWirelessClientsLatencyStats


    public
                getNetworkWirelessClientsLatencyStats(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : object

Aggregated latency info for this network, grouped by clients

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

object —

getNetworkWirelessClientsLatencyStatsAsync()

Operation getNetworkWirelessClientsLatencyStatsAsync


    public
                getNetworkWirelessClientsLatencyStatsAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientsLatencyStatsAsyncWithHttpInfo()

Operation getNetworkWirelessClientsLatencyStatsAsyncWithHttpInfo


    public
                getNetworkWirelessClientsLatencyStatsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessClientsLatencyStatsWithHttpInfo()

Operation getNetworkWirelessClientsLatencyStatsWithHttpInfo


    public
                getNetworkWirelessClientsLatencyStatsWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : array<string|int, mixed>

Aggregated latency info for this network, grouped by clients

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessConnectionStats()

Operation getNetworkWirelessConnectionStats


    public
                getNetworkWirelessConnectionStats(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : object

Aggregated connectivity info for this network

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

object —

getNetworkWirelessConnectionStatsAsync()

Operation getNetworkWirelessConnectionStatsAsync


    public
                getNetworkWirelessConnectionStatsAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : PromiseInterface

Aggregated connectivity info for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessConnectionStatsAsyncWithHttpInfo()

Operation getNetworkWirelessConnectionStatsAsyncWithHttpInfo


    public
                getNetworkWirelessConnectionStatsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : PromiseInterface

Aggregated connectivity info for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessConnectionStatsWithHttpInfo()

Operation getNetworkWirelessConnectionStatsWithHttpInfo


    public
                getNetworkWirelessConnectionStatsWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : array<string|int, mixed>

Aggregated connectivity info for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessDataRateHistory()

Operation getNetworkWirelessDataRateHistory


    public
                getNetworkWirelessDataRateHistory(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : object

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

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

object —

getNetworkWirelessDataRateHistoryAsync()

Operation getNetworkWirelessDataRateHistoryAsync


    public
                getNetworkWirelessDataRateHistoryAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : PromiseInterface

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessDataRateHistoryAsyncWithHttpInfo()

Operation getNetworkWirelessDataRateHistoryAsyncWithHttpInfo


    public
                getNetworkWirelessDataRateHistoryAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : PromiseInterface

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessDataRateHistoryWithHttpInfo()

Operation getNetworkWirelessDataRateHistoryWithHttpInfo


    public
                getNetworkWirelessDataRateHistoryWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : array<string|int, mixed>

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessDevicesConnectionStats()

Operation getNetworkWirelessDevicesConnectionStats


    public
                getNetworkWirelessDevicesConnectionStats(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : object

Aggregated connectivity info for this network, grouped by node

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

object —

getNetworkWirelessDevicesConnectionStatsAsync()

Operation getNetworkWirelessDevicesConnectionStatsAsync


    public
                getNetworkWirelessDevicesConnectionStatsAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : PromiseInterface

Aggregated connectivity info for this network, grouped by node

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessDevicesConnectionStatsAsyncWithHttpInfo()

Operation getNetworkWirelessDevicesConnectionStatsAsyncWithHttpInfo


    public
                getNetworkWirelessDevicesConnectionStatsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : PromiseInterface

Aggregated connectivity info for this network, grouped by node

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessDevicesConnectionStatsWithHttpInfo()

Operation getNetworkWirelessDevicesConnectionStatsWithHttpInfo


    public
                getNetworkWirelessDevicesConnectionStatsWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : array<string|int, mixed>

Aggregated connectivity info for this network, grouped by node

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessDevicesLatencyStats()

Operation getNetworkWirelessDevicesLatencyStats


    public
                getNetworkWirelessDevicesLatencyStats(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : object

Aggregated latency info for this network, grouped by node

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

object —

getNetworkWirelessDevicesLatencyStatsAsync()

Operation getNetworkWirelessDevicesLatencyStatsAsync


    public
                getNetworkWirelessDevicesLatencyStatsAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for this network, grouped by node

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessDevicesLatencyStatsAsyncWithHttpInfo()

Operation getNetworkWirelessDevicesLatencyStatsAsyncWithHttpInfo


    public
                getNetworkWirelessDevicesLatencyStatsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for this network, grouped by node

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessDevicesLatencyStatsWithHttpInfo()

Operation getNetworkWirelessDevicesLatencyStatsWithHttpInfo


    public
                getNetworkWirelessDevicesLatencyStatsWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : array<string|int, mixed>

Aggregated latency info for this network, grouped by node

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessFailedConnections()

Operation getNetworkWirelessFailedConnections


    public
                getNetworkWirelessFailedConnections(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $serial = null ][, string $client_id = null ]) : object

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

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$serial : string = null: Filter by AP (optional)
$client_id : string = null: Filter by client MAC (optional)

Tags

Return values

object —

getNetworkWirelessFailedConnectionsAsync()

Operation getNetworkWirelessFailedConnectionsAsync


    public
                getNetworkWirelessFailedConnectionsAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $serial = null ][, string $client_id = null ]) : PromiseInterface

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$serial : string = null: Filter by AP (optional)
$client_id : string = null: Filter by client MAC (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessFailedConnectionsAsyncWithHttpInfo()

Operation getNetworkWirelessFailedConnectionsAsyncWithHttpInfo


    public
                getNetworkWirelessFailedConnectionsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $serial = null ][, string $client_id = null ]) : PromiseInterface

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$serial : string = null: Filter by AP (optional)
$client_id : string = null: Filter by client MAC (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessFailedConnectionsWithHttpInfo()

Operation getNetworkWirelessFailedConnectionsWithHttpInfo


    public
                getNetworkWirelessFailedConnectionsWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $serial = null ][, string $client_id = null ]) : array<string|int, mixed>

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$serial : string = null: Filter by AP (optional)
$client_id : string = null: Filter by client MAC (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessLatencyHistory()

Operation getNetworkWirelessLatencyHistory


    public
                getNetworkWirelessLatencyHistory(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ][, string $access_category = null ]) : object

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

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)
$access_category : string = null: Filter by access category. (optional)

Tags

Return values

object —

getNetworkWirelessLatencyHistoryAsync()

Operation getNetworkWirelessLatencyHistoryAsync


    public
                getNetworkWirelessLatencyHistoryAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ][, string $access_category = null ]) : PromiseInterface

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)
$access_category : string = null: Filter by access category. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessLatencyHistoryAsyncWithHttpInfo()

Operation getNetworkWirelessLatencyHistoryAsyncWithHttpInfo


    public
                getNetworkWirelessLatencyHistoryAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ][, string $access_category = null ]) : PromiseInterface

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)
$access_category : string = null: Filter by access category. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessLatencyHistoryWithHttpInfo()

Operation getNetworkWirelessLatencyHistoryWithHttpInfo


    public
                getNetworkWirelessLatencyHistoryWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ][, string $access_category = null ]) : array<string|int, mixed>

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

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)
$access_category : string = null: Filter by access category. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessLatencyStats()

Operation getNetworkWirelessLatencyStats


    public
                getNetworkWirelessLatencyStats(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : object

Aggregated latency info for this network

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

object —

getNetworkWirelessLatencyStatsAsync()

Operation getNetworkWirelessLatencyStatsAsync


    public
                getNetworkWirelessLatencyStatsAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessLatencyStatsAsyncWithHttpInfo()

Operation getNetworkWirelessLatencyStatsAsyncWithHttpInfo


    public
                getNetworkWirelessLatencyStatsAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : PromiseInterface

Aggregated latency info for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessLatencyStatsWithHttpInfo()

Operation getNetworkWirelessLatencyStatsWithHttpInfo


    public
                getNetworkWirelessLatencyStatsWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : array<string|int, mixed>

Aggregated latency info for this network

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessMeshStatuses()

Operation getNetworkWirelessMeshStatuses


    public
                getNetworkWirelessMeshStatuses(string $network_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

List wireless mesh statuses for repeaters

Parameters

$network_id : string: network_id (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 500. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

object —

getNetworkWirelessMeshStatusesAsync()

Operation getNetworkWirelessMeshStatusesAsync


    public
                getNetworkWirelessMeshStatusesAsync(string $network_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

List wireless mesh statuses for repeaters

Parameters

$network_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 500. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessMeshStatusesAsyncWithHttpInfo()

Operation getNetworkWirelessMeshStatusesAsyncWithHttpInfo


    public
                getNetworkWirelessMeshStatusesAsyncWithHttpInfo(string $network_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

List wireless mesh statuses for repeaters

Parameters

$network_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 500. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessMeshStatusesWithHttpInfo()

Operation getNetworkWirelessMeshStatusesWithHttpInfo


    public
                getNetworkWirelessMeshStatusesWithHttpInfo(string $network_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

List wireless mesh statuses for repeaters

Parameters

$network_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 500. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessSignalQualityHistory()

Operation getNetworkWirelessSignalQualityHistory


    public
                getNetworkWirelessSignalQualityHistory(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : object

Return signal quality (SNR/RSSI) over time for a device or network client

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

object —

getNetworkWirelessSignalQualityHistoryAsync()

Operation getNetworkWirelessSignalQualityHistoryAsync


    public
                getNetworkWirelessSignalQualityHistoryAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : PromiseInterface

Return signal quality (SNR/RSSI) over time for a device or network client

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessSignalQualityHistoryAsyncWithHttpInfo()

Operation getNetworkWirelessSignalQualityHistoryAsyncWithHttpInfo


    public
                getNetworkWirelessSignalQualityHistoryAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : PromiseInterface

Return signal quality (SNR/RSSI) over time for a device or network client

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessSignalQualityHistoryWithHttpInfo()

Operation getNetworkWirelessSignalQualityHistoryWithHttpInfo


    public
                getNetworkWirelessSignalQualityHistoryWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : array<string|int, mixed>

Return signal quality (SNR/RSSI) over time for a device or network client

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkWirelessUsageHistory()

Operation getNetworkWirelessUsageHistory


    public
                getNetworkWirelessUsageHistory(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : object

Return AP usage over time for a device or network client

Parameters

$network_id : string: network_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device AP usage over time inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device. Requires :band. (optional)
$ap_tag : string = null: Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

object —

getNetworkWirelessUsageHistoryAsync()

Operation getNetworkWirelessUsageHistoryAsync


    public
                getNetworkWirelessUsageHistoryAsync(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : PromiseInterface

Return AP usage over time for a device or network client

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device AP usage over time inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device. Requires :band. (optional)
$ap_tag : string = null: Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessUsageHistoryAsyncWithHttpInfo()

Operation getNetworkWirelessUsageHistoryAsyncWithHttpInfo


    public
                getNetworkWirelessUsageHistoryAsyncWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : PromiseInterface

Return AP usage over time for a device or network client

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device AP usage over time inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device. Requires :band. (optional)
$ap_tag : string = null: Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

PromiseInterface —

getNetworkWirelessUsageHistoryWithHttpInfo()

Operation getNetworkWirelessUsageHistoryWithHttpInfo


    public
                getNetworkWirelessUsageHistoryWithHttpInfo(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : array<string|int, mixed>

Return AP usage over time for a device or network client

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device AP usage over time inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device. Requires :band. (optional)
$ap_tag : string = null: Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationApiRequests()

Operation getOrganizationApiRequests


    public
                getOrganizationApiRequests(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $admin_id = null ][, string $path = null ][, string $method = null ][, int $response_code = null ][, string $source_ip = null ]) : object

List the API requests made by an organization

Parameters

$organization_id : string: organization_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$admin_id : string = null: Filter the results by the ID of the admin who made the API requests (optional)
$path : string = null: Filter the results by the path of the API requests (optional)
$method : string = null: Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') (optional)
$response_code : int = null: Filter the results by the response code of the API requests (optional)
$source_ip : string = null: Filter the results by the IP address of the originating API request (optional)

Tags

Return values

object —

getOrganizationApiRequestsAsync()

Operation getOrganizationApiRequestsAsync


    public
                getOrganizationApiRequestsAsync(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $admin_id = null ][, string $path = null ][, string $method = null ][, int $response_code = null ][, string $source_ip = null ]) : PromiseInterface

List the API requests made by an organization

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$admin_id : string = null: Filter the results by the ID of the admin who made the API requests (optional)
$path : string = null: Filter the results by the path of the API requests (optional)
$method : string = null: Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') (optional)
$response_code : int = null: Filter the results by the response code of the API requests (optional)
$source_ip : string = null: Filter the results by the IP address of the originating API request (optional)

Tags

Return values

PromiseInterface —

getOrganizationApiRequestsAsyncWithHttpInfo()

Operation getOrganizationApiRequestsAsyncWithHttpInfo


    public
                getOrganizationApiRequestsAsyncWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $admin_id = null ][, string $path = null ][, string $method = null ][, int $response_code = null ][, string $source_ip = null ]) : PromiseInterface

List the API requests made by an organization

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$admin_id : string = null: Filter the results by the ID of the admin who made the API requests (optional)
$path : string = null: Filter the results by the path of the API requests (optional)
$method : string = null: Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') (optional)
$response_code : int = null: Filter the results by the response code of the API requests (optional)
$source_ip : string = null: Filter the results by the IP address of the originating API request (optional)

Tags

Return values

PromiseInterface —

getOrganizationApiRequestsOverview()

Operation getOrganizationApiRequestsOverview


    public
                getOrganizationApiRequestsOverview(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : object

Return an aggregated overview of API requests data

Parameters

$organization_id : string: organization_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)

Tags

Return values

object —

getOrganizationApiRequestsOverviewAsync()

Operation getOrganizationApiRequestsOverviewAsync


    public
                getOrganizationApiRequestsOverviewAsync(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface

Return an aggregated overview of API requests data

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)

Tags

Return values

PromiseInterface —

getOrganizationApiRequestsOverviewAsyncWithHttpInfo()

Operation getOrganizationApiRequestsOverviewAsyncWithHttpInfo


    public
                getOrganizationApiRequestsOverviewAsyncWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface

Return an aggregated overview of API requests data

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)

Tags

Return values

PromiseInterface —

getOrganizationApiRequestsOverviewWithHttpInfo()

Operation getOrganizationApiRequestsOverviewWithHttpInfo


    public
                getOrganizationApiRequestsOverviewWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : array<string|int, mixed>

Return an aggregated overview of API requests data

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationApiRequestsWithHttpInfo()

Operation getOrganizationApiRequestsWithHttpInfo


    public
                getOrganizationApiRequestsWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $admin_id = null ][, string $path = null ][, string $method = null ][, int $response_code = null ][, string $source_ip = null ]) : array<string|int, mixed>

List the API requests made by an organization

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$admin_id : string = null: Filter the results by the ID of the admin who made the API requests (optional)
$path : string = null: Filter the results by the path of the API requests (optional)
$method : string = null: Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') (optional)
$response_code : int = null: Filter the results by the response code of the API requests (optional)
$source_ip : string = null: Filter the results by the IP address of the originating API request (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationApplianceSecurityEvents()

Operation getOrganizationApplianceSecurityEvents


    public
                getOrganizationApplianceSecurityEvents(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : object

List the security events for an organization

Parameters

$organization_id : string: organization_id (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

object —

getOrganizationApplianceSecurityEventsAsync()

Operation getOrganizationApplianceSecurityEventsAsync


    public
                getOrganizationApplianceSecurityEventsAsync(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : PromiseInterface

List the security events for an organization

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

PromiseInterface —

getOrganizationApplianceSecurityEventsAsyncWithHttpInfo()

Operation getOrganizationApplianceSecurityEventsAsyncWithHttpInfo


    public
                getOrganizationApplianceSecurityEventsAsyncWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : PromiseInterface

List the security events for an organization

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

PromiseInterface —

getOrganizationApplianceSecurityEventsWithHttpInfo()

Operation getOrganizationApplianceSecurityEventsWithHttpInfo


    public
                getOrganizationApplianceSecurityEventsWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : array<string|int, mixed>

List the security events for an organization

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationApplianceUplinkStatuses()

Operation getOrganizationApplianceUplinkStatuses


    public
                getOrganizationApplianceUplinkStatuses(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : object

List the uplink status of every Meraki MX and Z series appliances in the organization

Parameters

$organization_id : string: organization_id (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

object —

getOrganizationApplianceUplinkStatusesAsync()

Operation getOrganizationApplianceUplinkStatusesAsync


    public
                getOrganizationApplianceUplinkStatusesAsync(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : PromiseInterface

List the uplink status of every Meraki MX and Z series appliances in the organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

PromiseInterface —

getOrganizationApplianceUplinkStatusesAsyncWithHttpInfo()

Operation getOrganizationApplianceUplinkStatusesAsyncWithHttpInfo


    public
                getOrganizationApplianceUplinkStatusesAsyncWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : PromiseInterface

List the uplink status of every Meraki MX and Z series appliances in the organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

PromiseInterface —

getOrganizationApplianceUplinkStatusesWithHttpInfo()

Operation getOrganizationApplianceUplinkStatusesWithHttpInfo


    public
                getOrganizationApplianceUplinkStatusesWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : array<string|int, mixed>

List the uplink status of every Meraki MX and Z series appliances in the organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationApplianceVpnStats()

Operation getOrganizationApplianceVpnStats


    public
                getOrganizationApplianceVpnStats(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : object

Show VPN history stat for networks in an organization

Parameters

$organization_id : string: organization_id (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 300. Default is 300. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N_12345678&networkIds[]=L_3456 (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

object —

getOrganizationApplianceVpnStatsAsync()

Operation getOrganizationApplianceVpnStatsAsync


    public
                getOrganizationApplianceVpnStatsAsync(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface

Show VPN history stat for networks in an organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 300. Default is 300. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N_12345678&networkIds[]=L_3456 (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

PromiseInterface —

getOrganizationApplianceVpnStatsAsyncWithHttpInfo()

Operation getOrganizationApplianceVpnStatsAsyncWithHttpInfo


    public
                getOrganizationApplianceVpnStatsAsyncWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : PromiseInterface

Show VPN history stat for networks in an organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 300. Default is 300. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N_12345678&networkIds[]=L_3456 (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

PromiseInterface —

getOrganizationApplianceVpnStatsWithHttpInfo()

Operation getOrganizationApplianceVpnStatsWithHttpInfo


    public
                getOrganizationApplianceVpnStatsWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : array<string|int, mixed>

Show VPN history stat for networks in an organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 300. Default is 300. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N_12345678&networkIds[]=L_3456 (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationApplianceVpnStatuses()

Operation getOrganizationApplianceVpnStatuses


    public
                getOrganizationApplianceVpnStatuses(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ]) : object

Show VPN status for networks in an organization

Parameters

$organization_id : string: organization_id (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 300. Default is 300. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N_12345678&networkIds[]=L_3456 (optional)

Tags

Return values

object —

getOrganizationApplianceVpnStatusesAsync()

Operation getOrganizationApplianceVpnStatusesAsync


    public
                getOrganizationApplianceVpnStatusesAsync(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ]) : PromiseInterface

Show VPN status for networks in an organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 300. Default is 300. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N_12345678&networkIds[]=L_3456 (optional)

Tags

Return values

PromiseInterface —

getOrganizationApplianceVpnStatusesAsyncWithHttpInfo()

Operation getOrganizationApplianceVpnStatusesAsyncWithHttpInfo


    public
                getOrganizationApplianceVpnStatusesAsyncWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ]) : PromiseInterface

Show VPN status for networks in an organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 300. Default is 300. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N_12345678&networkIds[]=L_3456 (optional)

Tags

Return values

PromiseInterface —

getOrganizationApplianceVpnStatusesWithHttpInfo()

Operation getOrganizationApplianceVpnStatusesWithHttpInfo


    public
                getOrganizationApplianceVpnStatusesWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ]) : array<string|int, mixed>

Show VPN status for networks in an organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 300. Default is 300. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N_12345678&networkIds[]=L_3456 (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationCellularGatewayUplinkStatuses()

Operation getOrganizationCellularGatewayUplinkStatuses


    public
                getOrganizationCellularGatewayUplinkStatuses(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : object

List the uplink status of every Meraki MG cellular gateway in the organization

Parameters

$organization_id : string: organization_id (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

object —

getOrganizationCellularGatewayUplinkStatusesAsync()

Operation getOrganizationCellularGatewayUplinkStatusesAsync


    public
                getOrganizationCellularGatewayUplinkStatusesAsync(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : PromiseInterface

List the uplink status of every Meraki MG cellular gateway in the organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

PromiseInterface —

getOrganizationCellularGatewayUplinkStatusesAsyncWithHttpInfo()

Operation getOrganizationCellularGatewayUplinkStatusesAsyncWithHttpInfo


    public
                getOrganizationCellularGatewayUplinkStatusesAsyncWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : PromiseInterface

List the uplink status of every Meraki MG cellular gateway in the organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

PromiseInterface —

getOrganizationCellularGatewayUplinkStatusesWithHttpInfo()

Operation getOrganizationCellularGatewayUplinkStatusesWithHttpInfo


    public
                getOrganizationCellularGatewayUplinkStatusesWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : array<string|int, mixed>

List the uplink status of every Meraki MG cellular gateway in the organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationConfigurationChanges()

Operation getOrganizationConfigurationChanges


    public
                getOrganizationConfigurationChanges(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $network_id = null ][, string $admin_id = null ]) : object

View the Change Log for your organization

Parameters

$organization_id : string: organization_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 365 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 5000. Default is 5000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_id : string = null: Filters on the given network (optional)
$admin_id : string = null: Filters on the given Admin (optional)

Tags

Return values

object —

getOrganizationConfigurationChangesAsync()

Operation getOrganizationConfigurationChangesAsync


    public
                getOrganizationConfigurationChangesAsync(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $network_id = null ][, string $admin_id = null ]) : PromiseInterface

View the Change Log for your organization

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 365 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 5000. Default is 5000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_id : string = null: Filters on the given network (optional)
$admin_id : string = null: Filters on the given Admin (optional)

Tags

Return values

PromiseInterface —

getOrganizationConfigurationChangesAsyncWithHttpInfo()

Operation getOrganizationConfigurationChangesAsyncWithHttpInfo


    public
                getOrganizationConfigurationChangesAsyncWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $network_id = null ][, string $admin_id = null ]) : PromiseInterface

View the Change Log for your organization

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 365 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 5000. Default is 5000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_id : string = null: Filters on the given network (optional)
$admin_id : string = null: Filters on the given Admin (optional)

Tags

Return values

PromiseInterface —

getOrganizationConfigurationChangesWithHttpInfo()

Operation getOrganizationConfigurationChangesWithHttpInfo


    public
                getOrganizationConfigurationChangesWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $network_id = null ][, string $admin_id = null ]) : array<string|int, mixed>

View the Change Log for your organization

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 365 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 5000. Default is 5000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_id : string = null: Filters on the given network (optional)
$admin_id : string = null: Filters on the given Admin (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationDevicesStatuses()

Operation getOrganizationDevicesStatuses


    public
                getOrganizationDevicesStatuses(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : object

List the status of every Meraki device in the organization

Parameters

$organization_id : string: organization_id (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

object —

getOrganizationDevicesStatusesAsync()

Operation getOrganizationDevicesStatusesAsync


    public
                getOrganizationDevicesStatusesAsync(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

List the status of every Meraki device in the organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getOrganizationDevicesStatusesAsyncWithHttpInfo()

Operation getOrganizationDevicesStatusesAsyncWithHttpInfo


    public
                getOrganizationDevicesStatusesAsyncWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : PromiseInterface

List the status of every Meraki device in the organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

PromiseInterface —

getOrganizationDevicesStatusesWithHttpInfo()

Operation getOrganizationDevicesStatusesWithHttpInfo


    public
                getOrganizationDevicesStatusesWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : array<string|int, mixed>

List the status of every Meraki device in the organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationDevicesUplinksLossAndLatency()

Operation getOrganizationDevicesUplinksLossAndLatency


    public
                getOrganizationDevicesUplinksLossAndLatency(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : object

Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago

Parameters

$organization_id : string: organization_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (optional)
$timespan : float = null: 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 5 minutes. The default is 5 minutes. (optional)
$uplink : string = null: Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
$ip : string = null: Optional filter for a specific destination IP. Default will return all destination IPs. (optional)

Tags

Return values

object —

getOrganizationDevicesUplinksLossAndLatencyAsync()

Operation getOrganizationDevicesUplinksLossAndLatencyAsync


    public
                getOrganizationDevicesUplinksLossAndLatencyAsync(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : PromiseInterface

Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (optional)
$timespan : float = null: 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 5 minutes. The default is 5 minutes. (optional)
$uplink : string = null: Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
$ip : string = null: Optional filter for a specific destination IP. Default will return all destination IPs. (optional)

Tags

Return values

PromiseInterface —

getOrganizationDevicesUplinksLossAndLatencyAsyncWithHttpInfo()

Operation getOrganizationDevicesUplinksLossAndLatencyAsyncWithHttpInfo


    public
                getOrganizationDevicesUplinksLossAndLatencyAsyncWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : PromiseInterface

Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (optional)
$timespan : float = null: 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 5 minutes. The default is 5 minutes. (optional)
$uplink : string = null: Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
$ip : string = null: Optional filter for a specific destination IP. Default will return all destination IPs. (optional)

Tags

Return values

PromiseInterface —

getOrganizationDevicesUplinksLossAndLatencyWithHttpInfo()

Operation getOrganizationDevicesUplinksLossAndLatencyWithHttpInfo


    public
                getOrganizationDevicesUplinksLossAndLatencyWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : array<string|int, mixed>

Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (optional)
$timespan : float = null: 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 5 minutes. The default is 5 minutes. (optional)
$uplink : string = null: Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
$ip : string = null: Optional filter for a specific destination IP. Default will return all destination IPs. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationLicensesOverview()

Operation getOrganizationLicensesOverview


    public
                getOrganizationLicensesOverview(string $organization_id) : object

Return an overview of the license state for an organization

Parameters

$organization_id : string: organization_id (required)

Tags

Return values

object —

getOrganizationLicensesOverviewAsync()

Operation getOrganizationLicensesOverviewAsync


    public
                getOrganizationLicensesOverviewAsync(string $organization_id) : PromiseInterface

Return an overview of the license state for an organization

Parameters

$organization_id : string: (required)

Tags

Return values

PromiseInterface —

getOrganizationLicensesOverviewAsyncWithHttpInfo()

Operation getOrganizationLicensesOverviewAsyncWithHttpInfo


    public
                getOrganizationLicensesOverviewAsyncWithHttpInfo(string $organization_id) : PromiseInterface

Return an overview of the license state for an organization

Parameters

$organization_id : string: (required)

Tags

Return values

PromiseInterface —

getOrganizationLicensesOverviewWithHttpInfo()

Operation getOrganizationLicensesOverviewWithHttpInfo


    public
                getOrganizationLicensesOverviewWithHttpInfo(string $organization_id) : array<string|int, mixed>

Return an overview of the license state for an organization

Parameters

$organization_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationOpenapiSpec()

Operation getOrganizationOpenapiSpec


    public
                getOrganizationOpenapiSpec(string $organization_id) : object

Return the OpenAPI 2.0 Specification of the organization's API documentation in JSON

Parameters

$organization_id : string: organization_id (required)

Tags

Return values

object —

getOrganizationOpenapiSpecAsync()

Operation getOrganizationOpenapiSpecAsync


    public
                getOrganizationOpenapiSpecAsync(string $organization_id) : PromiseInterface

Return the OpenAPI 2.0 Specification of the organization's API documentation in JSON

Parameters

$organization_id : string: (required)

Tags

Return values

PromiseInterface —

getOrganizationOpenapiSpecAsyncWithHttpInfo()

Operation getOrganizationOpenapiSpecAsyncWithHttpInfo


    public
                getOrganizationOpenapiSpecAsyncWithHttpInfo(string $organization_id) : PromiseInterface

Return the OpenAPI 2.0 Specification of the organization's API documentation in JSON

Parameters

$organization_id : string: (required)

Tags

Return values

PromiseInterface —

getOrganizationOpenapiSpecWithHttpInfo()

Operation getOrganizationOpenapiSpecWithHttpInfo


    public
                getOrganizationOpenapiSpecWithHttpInfo(string $organization_id) : array<string|int, mixed>

Return the OpenAPI 2.0 Specification of the organization's API documentation in JSON

Parameters

$organization_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationUplinksStatuses()

Operation getOrganizationUplinksStatuses


    public
                getOrganizationUplinksStatuses(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : object

List the uplink status of every Meraki MX, MG and Z series devices in the organization

Parameters

$organization_id : string: organization_id (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

object —

getOrganizationUplinksStatusesAsync()

Operation getOrganizationUplinksStatusesAsync


    public
                getOrganizationUplinksStatusesAsync(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : PromiseInterface

List the uplink status of every Meraki MX, MG and Z series devices in the organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

PromiseInterface —

getOrganizationUplinksStatusesAsyncWithHttpInfo()

Operation getOrganizationUplinksStatusesAsyncWithHttpInfo


    public
                getOrganizationUplinksStatusesAsyncWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : PromiseInterface

List the uplink status of every Meraki MX, MG and Z series devices in the organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

PromiseInterface —

getOrganizationUplinksStatusesWithHttpInfo()

Operation getOrganizationUplinksStatusesWithHttpInfo


    public
                getOrganizationUplinksStatusesWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : array<string|int, mixed>

List the uplink status of every Meraki MX, MG and Z series devices in the organization

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationWebhooksAlertTypes()

Operation getOrganizationWebhooksAlertTypes


    public
                getOrganizationWebhooksAlertTypes(string $organization_id) : object

Return a list of alert types to be used with managing webhook alerts

Parameters

$organization_id : string: organization_id (required)

Tags

Return values

object —

getOrganizationWebhooksAlertTypesAsync()

Operation getOrganizationWebhooksAlertTypesAsync


    public
                getOrganizationWebhooksAlertTypesAsync(string $organization_id) : PromiseInterface

Return a list of alert types to be used with managing webhook alerts

Parameters

$organization_id : string: (required)

Tags

Return values

PromiseInterface —

getOrganizationWebhooksAlertTypesAsyncWithHttpInfo()

Operation getOrganizationWebhooksAlertTypesAsyncWithHttpInfo


    public
                getOrganizationWebhooksAlertTypesAsyncWithHttpInfo(string $organization_id) : PromiseInterface

Return a list of alert types to be used with managing webhook alerts

Parameters

$organization_id : string: (required)

Tags

Return values

PromiseInterface —

getOrganizationWebhooksAlertTypesWithHttpInfo()

Operation getOrganizationWebhooksAlertTypesWithHttpInfo


    public
                getOrganizationWebhooksAlertTypesWithHttpInfo(string $organization_id) : array<string|int, mixed>

Return a list of alert types to be used with managing webhook alerts

Parameters

$organization_id : string: (required)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getOrganizationWebhooksLogs()

Operation getOrganizationWebhooksLogs


    public
                getOrganizationWebhooksLogs(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $url = null ]) : object

Return the log of webhook POSTs sent

Parameters

$organization_id : string: organization_id (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 90 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$url : string = null: The URL the webhook was sent to (optional)

Tags

Return values

object —

getOrganizationWebhooksLogsAsync()

Operation getOrganizationWebhooksLogsAsync


    public
                getOrganizationWebhooksLogsAsync(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $url = null ]) : PromiseInterface

Return the log of webhook POSTs sent

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 90 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$url : string = null: The URL the webhook was sent to (optional)

Tags

Return values

PromiseInterface —

getOrganizationWebhooksLogsAsyncWithHttpInfo()

Operation getOrganizationWebhooksLogsAsyncWithHttpInfo


    public
                getOrganizationWebhooksLogsAsyncWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $url = null ]) : PromiseInterface

Return the log of webhook POSTs sent

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 90 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$url : string = null: The URL the webhook was sent to (optional)

Tags

Return values

PromiseInterface —

getOrganizationWebhooksLogsWithHttpInfo()

Operation getOrganizationWebhooksLogsWithHttpInfo


    public
                getOrganizationWebhooksLogsWithHttpInfo(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $url = null ]) : array<string|int, mixed>

Return the log of webhook POSTs sent

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 90 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$url : string = null: The URL the webhook was sent to (optional)

Tags

Return values

array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option


    protected
                createHttpClientOption() : array<string|int, mixed>

Tags

Return values

array<string|int, mixed> —

of http client options

generateDeviceCameraSnapshotRequest()

Create request for operation 'generateDeviceCameraSnapshot'


    protected
                generateDeviceCameraSnapshotRequest(string $serial[, GenerateDeviceCameraSnapshot $generate_device_camera_snapshot = null ]) : Request

Parameters

$serial : string: (required)
$generate_device_camera_snapshot : GenerateDeviceCameraSnapshot = null: (optional)

Tags

Return values

Request —

getDeviceApplianceDhcpSubnetsRequest()

Create request for operation 'getDeviceApplianceDhcpSubnets'


    protected
                getDeviceApplianceDhcpSubnetsRequest(string $serial) : Request

Parameters

$serial : string: (required)

Tags

Return values

Request —

getDeviceAppliancePerformanceRequest()

Create request for operation 'getDeviceAppliancePerformance'


    protected
                getDeviceAppliancePerformanceRequest(string $serial) : Request

Parameters

$serial : string: (required)

Tags

Return values

Request —

getDeviceCameraAnalyticsLiveRequest()

Create request for operation 'getDeviceCameraAnalyticsLive'


    protected
                getDeviceCameraAnalyticsLiveRequest(string $serial) : Request

Parameters

$serial : string: (required)

Tags

Return values

Request —

getDeviceCameraAnalyticsOverviewRequest()

Create request for operation 'getDeviceCameraAnalyticsOverview'


    protected
                getDeviceCameraAnalyticsOverviewRequest(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : Request

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. The default is 1 hour. (optional)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

Request —

getDeviceCameraAnalyticsRecentRequest()

Create request for operation 'getDeviceCameraAnalyticsRecent'


    protected
                getDeviceCameraAnalyticsRecentRequest(string $serial[, string $object_type = null ]) : Request

Parameters

$serial : string: (required)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

Request —

getDeviceCameraAnalyticsZoneHistoryRequest()

Create request for operation 'getDeviceCameraAnalyticsZoneHistory'


    protected
                getDeviceCameraAnalyticsZoneHistoryRequest(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : Request

Parameters

$serial : string: (required)
$zone_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 14 hours after t0. (optional)
$timespan : float = null: 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 14 hours. The default is 1 hour. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (optional)
$object_type : string = null: [optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags

Return values

Request —

getDeviceCameraAnalyticsZonesRequest()

Create request for operation 'getDeviceCameraAnalyticsZones'


    protected
                getDeviceCameraAnalyticsZonesRequest(string $serial) : Request

Parameters

$serial : string: (required)

Tags

Return values

Request —

getDeviceClientsRequest()

Create request for operation 'getDeviceClients'


    protected
                getDeviceClientsRequest(string $serial[, string $t0 = null ][, float $timespan = null ]) : Request

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)

Tags

Return values

Request —

getDeviceLldpCdpRequest()

Create request for operation 'getDeviceLldpCdp'


    protected
                getDeviceLldpCdpRequest(string $serial) : Request

Parameters

$serial : string: (required)

Tags

Return values

Request —

getDeviceLossAndLatencyHistoryRequest()

Create request for operation 'getDeviceLossAndLatencyHistory'


    protected
                getDeviceLossAndLatencyHistoryRequest(string $serial, string $ip[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $uplink = null ]) : Request

Parameters

$serial : string: (required)
$ip : string: The destination IP used to obtain the requested stats. This is required. (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60, 600, 3600, 86400. The default is 60. (optional)
$uplink : string = null: The WAN uplink used to obtain the requested stats. Valid uplinks are wan1, wan2, cellular. The default is wan1. (optional)

Tags

Return values

Request —

getDeviceSwitchPortsStatusesPacketsRequest()

Create request for operation 'getDeviceSwitchPortsStatusesPackets'


    protected
                getDeviceSwitchPortsStatusesPacketsRequest(string $serial[, string $t0 = null ][, float $timespan = null ]) : Request

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 1 day from today. (optional)
$timespan : float = null: 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 1 day. The default is 1 day. (optional)

Tags

Return values

Request —

getDeviceSwitchPortsStatusesRequest()

Create request for operation 'getDeviceSwitchPortsStatuses'


    protected
                getDeviceSwitchPortsStatusesRequest(string $serial[, string $t0 = null ][, float $timespan = null ]) : Request

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)

Tags

Return values

Request —

getDeviceWirelessConnectionStatsRequest()

Create request for operation 'getDeviceWirelessConnectionStats'


    protected
                getDeviceWirelessConnectionStatsRequest(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : Request

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

Request —

getDeviceWirelessLatencyStatsRequest()

Create request for operation 'getDeviceWirelessLatencyStats'


    protected
                getDeviceWirelessLatencyStatsRequest(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : Request

Parameters

$serial : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

Request —

getDeviceWirelessStatusRequest()

Create request for operation 'getDeviceWirelessStatus'


    protected
                getDeviceWirelessStatusRequest(string $serial) : Request

Parameters

$serial : string: (required)

Tags

Return values

Request —

getNetworkApplianceClientSecurityEventsRequest()

Create request for operation 'getNetworkApplianceClientSecurityEvents'


    protected
                getNetworkApplianceClientSecurityEventsRequest(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

Request —

getNetworkApplianceSecurityEventsRequest()

Create request for operation 'getNetworkApplianceSecurityEvents'


    protected
                getNetworkApplianceSecurityEventsRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

Request —

getNetworkBluetoothClientRequest()

Create request for operation 'getNetworkBluetoothClient'


    protected
                getNetworkBluetoothClientRequest(string $network_id, string $bluetooth_client_id[, bool $include_connectivity_history = null ][, int $connectivity_history_timespan = null ]) : Request

Parameters

$network_id : string: (required)
$bluetooth_client_id : string: (required)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)
$connectivity_history_timespan : int = null: The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used. (optional)

Tags

Return values

Request —

getNetworkBluetoothClientsRequest()

Create request for operation 'getNetworkBluetoothClients'


    protected
                getNetworkBluetoothClientsRequest(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, bool $include_connectivity_history = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$timespan : float = null: 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 7 days. The default is 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 5 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$include_connectivity_history : bool = null: Include the connectivity history for this client (optional)

Tags

Return values

Request —

getNetworkClientRequest()

Create request for operation 'getNetworkClient'


    protected
                getNetworkClientRequest(string $network_id, string $client_id) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

Request —

getNetworkClientsApplicationUsageRequest()

Create request for operation 'getNetworkClientsApplicationUsage'


    protected
                getNetworkClientsApplicationUsageRequest(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : Request

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, eveusage histories application usagents for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

Request —

getNetworkClientsOverviewRequest()

Create request for operation 'getNetworkClientsOverview'


    protected
                getNetworkClientsOverviewRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 7200, 86400, 604800, 2592000. The default is 604800. (optional)

Tags

Return values

Request —

getNetworkClientsRequest()

Create request for operation 'getNetworkClients'


    protected
                getNetworkClientsRequest(string $network_id[, string $t0 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $statuses = null ][, string $ip = null ][, string $ip6 = null ][, string $ip6_local = null ][, string $mac = null ][, string $os = null ][, string $description = null ][, array<string|int, string> $recent_device_connections = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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 1 day. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$statuses : array<string|int, string> = null: Filters clients based on status. Can be one of 'Online' or 'Offline'. (optional)
$ip : string = null: Filters clients based on a partial or full match for the ip address field. (optional)
$ip6 : string = null: Filters clients based on a partial or full match for the ip6 address field. (optional)
$ip6_local : string = null: Filters clients based on a partial or full match for the ip6Local address field. (optional)
$mac : string = null: Filters clients based on a partial or full match for the mac address field. (optional)
$os : string = null: Filters clients based on a partial or full match for the os (operating system) field. (optional)
$description : string = null: Filters clients based on a partial or full match for the description field. (optional)
$recent_device_connections : array<string|int, string> = null: Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'. (optional)

Tags

Return values

Request —

getNetworkClientsUsageHistoriesRequest()

Create request for operation 'getNetworkClientsUsageHistories'


    protected
                getNetworkClientsUsageHistoriesRequest(string $network_id, string $clients[, int $ssid_number = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : Request

Parameters

$network_id : string: (required)
$clients : string: A list of client keys, MACs or IPs separated by comma. (required)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

Request —

getNetworkClientTrafficHistoryRequest()

Create request for operation 'getNetworkClientTrafficHistory'


    protected
                getNetworkClientTrafficHistoryRequest(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkClientUsageHistoryRequest()

Create request for operation 'getNetworkClientUsageHistory'


    protected
                getNetworkClientUsageHistoryRequest(string $network_id, string $client_id) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)

Tags

Return values

Request —

getNetworkEventsEventTypesRequest()

Create request for operation 'getNetworkEventsEventTypes'


    protected
                getNetworkEventsEventTypesRequest(string $network_id) : Request

Parameters

$network_id : string: (required)

Tags

Return values

Request —

getNetworkEventsRequest()

Create request for operation 'getNetworkEvents'


    protected
                getNetworkEventsRequest(string $network_id[, string $product_type = null ][, array<string|int, string> $included_event_types = null ][, array<string|int, string> $excluded_event_types = null ][, string $device_mac = null ][, string $device_serial = null ][, string $device_name = null ][, string $client_ip = null ][, string $client_mac = null ][, string $client_name = null ][, string $sm_device_mac = null ][, string $sm_device_name = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$product_type : string = null: The product type to fetch events for. This parameter is required for networks with multiple device types. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and environmental (optional)
$included_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to only include events with these types. (optional)
$excluded_event_types : array<string|int, string> = null: A list of event types. The returned events will be filtered to exclude events with these types. (optional)
$device_mac : string = null: The MAC address of the Meraki device which the list of events will be filtered with (optional)
$device_serial : string = null: The serial of the Meraki device which the list of events will be filtered with (optional)
$device_name : string = null: The name of the Meraki device which the list of events will be filtered with (optional)
$client_ip : string = null: The IP of the client which the list of events will be filtered with. Only supported for track-by-IP networks. (optional)
$client_mac : string = null: The MAC address of the client which the list of events will be filtered with. Only supported for track-by-MAC networks. (optional)
$client_name : string = null: The name, or partial name, of the client which the list of events will be filtered with (optional)
$sm_device_mac : string = null: The MAC address of the Systems Manager device which the list of events will be filtered with (optional)
$sm_device_name : string = null: The name of the Systems Manager device which the list of events will be filtered with (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkInsightApplicationHealthByTimeRequest()

Create request for operation 'getNetworkInsightApplicationHealthByTime'


    protected
                getNetworkInsightApplicationHealthByTimeRequest(string $network_id, string $application_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : Request

Parameters

$network_id : string: (required)
$application_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 7 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. The default is 2 hours. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 60, 300, 3600, 86400. The default is 300. (optional)

Tags

Return values

Request —

getNetworkNetworkHealthChannelUtilizationRequest()

Create request for operation 'getNetworkNetworkHealthChannelUtilization'


    protected
                getNetworkNetworkHealthChannelUtilizationRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600. The default is 600. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 100. Default is 10. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkSmDeviceCellularUsageHistoryRequest()

Create request for operation 'getNetworkSmDeviceCellularUsageHistory'


    protected
                getNetworkSmDeviceCellularUsageHistoryRequest(string $network_id, string $device_id) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)

Tags

Return values

Request —

getNetworkSmDeviceConnectivityRequest()

Create request for operation 'getNetworkSmDeviceConnectivity'


    protected
                getNetworkSmDeviceConnectivityRequest(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkSmDeviceDesktopLogsRequest()

Create request for operation 'getNetworkSmDeviceDesktopLogs'


    protected
                getNetworkSmDeviceDesktopLogsRequest(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkSmDeviceDeviceCommandLogsRequest()

Create request for operation 'getNetworkSmDeviceDeviceCommandLogs'


    protected
                getNetworkSmDeviceDeviceCommandLogsRequest(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkSmDevicePerformanceHistoryRequest()

Create request for operation 'getNetworkSmDevicePerformanceHistory'


    protected
                getNetworkSmDevicePerformanceHistoryRequest(string $network_id, string $device_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$device_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkSplashLoginAttemptsRequest()

Create request for operation 'getNetworkSplashLoginAttempts'


    protected
                getNetworkSplashLoginAttemptsRequest(string $network_id[, int $ssid_number = null ][, string $login_identifier = null ][, int $timespan = null ]) : Request

Parameters

$network_id : string: (required)
$ssid_number : int = null: Only return the login attempts for the specified SSID (optional)
$login_identifier : string = null: The username, email, or phone number used during login (optional)
$timespan : int = null: The timespan, in seconds, for the login attempts. The period will be from [timespan] seconds ago until now. The maximum timespan is 3 months (optional)

Tags

Return values

Request —

getNetworkTrafficRequest()

Create request for operation 'getNetworkTraffic'


    protected
                getNetworkTrafficRequest(string $network_id[, string $t0 = null ][, float $timespan = null ][, string $device_type = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 30 days from today. (optional)
$timespan : float = null: 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 30 days. (optional)
$device_type : string = null: Filter the data by device type: 'combined', 'wireless', 'switch' or 'appliance'. Defaults to 'combined'. When using 'combined', for each rule the data will come from the device type with the most usage. (optional)

Tags

Return values

Request —

getNetworkWirelessAirMarshalRequest()

Create request for operation 'getNetworkWirelessAirMarshal'


    protected
                getNetworkWirelessAirMarshalRequest(string $network_id[, string $t0 = null ][, float $timespan = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

Request —

getNetworkWirelessChannelUtilizationHistoryRequest()

Create request for operation 'getNetworkWirelessChannelUtilizationHistory'


    protected
                getNetworkWirelessChannelUtilizationHistoryRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device, per-band AP channel utilization metrics inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device to return AP channel utilization metrics for the queried device; either :band or :clientId must be jointly specified. (optional)
$ap_tag : string = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)

Tags

Return values

Request —

getNetworkWirelessClientConnectionStatsRequest()

Create request for operation 'getNetworkWirelessClientConnectionStats'


    protected
                getNetworkWirelessClientConnectionStatsRequest(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

Request —

getNetworkWirelessClientConnectivityEventsRequest()

Create request for operation 'getNetworkWirelessClientConnectivityEvents'


    protected
                getNetworkWirelessClientConnectivityEventsRequest(string $network_id, string $client_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, array<string|int, string> $types = null ][, array<string|int, string> $included_severities = null ][, string $band = null ][, int $ssid_number = null ][, string $device_serial = null ]) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$types : array<string|int, string> = null: 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'. (optional)
$included_severities : array<string|int, string> = null: 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'. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid_number : int = null: An SSID number to include. If not specified, events for all SSIDs will be returned. (optional)
$device_serial : string = null: Filter results by an AP's serial number. (optional)

Tags

Return values

Request —

getNetworkWirelessClientCountHistoryRequest()

Create request for operation 'getNetworkWirelessClientCountHistory'


    protected
                getNetworkWirelessClientCountHistoryRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device client counts over time inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

Request —

getNetworkWirelessClientLatencyHistoryRequest()

Create request for operation 'getNetworkWirelessClientLatencyHistory'


    protected
                getNetworkWirelessClientLatencyHistoryRequest(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ]) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 791 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 791 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 86400. The default is 86400. (optional)

Tags

Return values

Request —

getNetworkWirelessClientLatencyStatsRequest()

Create request for operation 'getNetworkWirelessClientLatencyStats'


    protected
                getNetworkWirelessClientLatencyStatsRequest(string $network_id, string $client_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : Request

Parameters

$network_id : string: (required)
$client_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkWirelessClientsConnectionStatsRequest()

Create request for operation 'getNetworkWirelessClientsConnectionStats'


    protected
                getNetworkWirelessClientsConnectionStatsRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

Request —

getNetworkWirelessClientsLatencyStatsRequest()

Create request for operation 'getNetworkWirelessClientsLatencyStats'


    protected
                getNetworkWirelessClientsLatencyStatsRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkWirelessConnectionStatsRequest()

Create request for operation 'getNetworkWirelessConnectionStats'


    protected
                getNetworkWirelessConnectionStatsRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

Request —

getNetworkWirelessDataRateHistoryRequest()

Create request for operation 'getNetworkWirelessDataRateHistory'


    protected
                getNetworkWirelessDataRateHistoryRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

Request —

getNetworkWirelessDevicesConnectionStatsRequest()

Create request for operation 'getNetworkWirelessDevicesConnectionStats'


    protected
                getNetworkWirelessDevicesConnectionStatsRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)

Tags

Return values

Request —

getNetworkWirelessDevicesLatencyStatsRequest()

Create request for operation 'getNetworkWirelessDevicesLatencyStats'


    protected
                getNetworkWirelessDevicesLatencyStatsRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkWirelessFailedConnectionsRequest()

Create request for operation 'getNetworkWirelessFailedConnections'


    protected
                getNetworkWirelessFailedConnectionsRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $serial = null ][, string $client_id = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$serial : string = null: Filter by AP (optional)
$client_id : string = null: Filter by client MAC (optional)

Tags

Return values

Request —

getNetworkWirelessLatencyHistoryRequest()

Create request for operation 'getNetworkWirelessLatencyHistory'


    protected
                getNetworkWirelessLatencyHistoryRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ][, string $access_category = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)
$access_category : string = null: Filter by access category. (optional)

Tags

Return values

Request —

getNetworkWirelessLatencyStatsRequest()

Create request for operation 'getNetworkWirelessLatencyStats'


    protected
                getNetworkWirelessLatencyStatsRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $band = null ][, int $ssid = null ][, int $vlan = null ][, string $ap_tag = null ][, string $fields = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 180 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)
$timespan : float = null: 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. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). Note that data prior to February 2020 will not have band information. (optional)
$ssid : int = null: Filter results by SSID (optional)
$vlan : int = null: Filter results by VLAN (optional)
$ap_tag : string = null: Filter results by AP Tag (optional)
$fields : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkWirelessMeshStatusesRequest()

Create request for operation 'getNetworkWirelessMeshStatuses'


    protected
                getNetworkWirelessMeshStatusesRequest(string $network_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$network_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 500. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

Request —

getNetworkWirelessSignalQualityHistoryRequest()

Create request for operation 'getNetworkWirelessSignalQualityHistory'


    protected
                getNetworkWirelessSignalQualityHistoryRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client. (optional)
$device_serial : string = null: Filter results by device. (optional)
$ap_tag : string = null: Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

Request —

getNetworkWirelessUsageHistoryRequest()

Create request for operation 'getNetworkWirelessUsageHistory'


    protected
                getNetworkWirelessUsageHistoryRequest(string $network_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, bool $auto_resolution = null ][, string $client_id = null ][, string $device_serial = null ][, string $ap_tag = null ][, string $band = null ][, int $ssid = null ]) : Request

Parameters

$network_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$resolution : int = null: The time resolution in seconds for returned data. The valid resolutions are: 300, 600, 1200, 3600, 14400, 86400. The default is 86400. (optional)
$auto_resolution : bool = null: Automatically select a data resolution based on the given timespan; this overrides the value specified by the 'resolution' parameter. The default setting is false. (optional)
$client_id : string = null: Filter results by network client to return per-device AP usage over time inner joined by the queried client's connection history. (optional)
$device_serial : string = null: Filter results by device. Requires :band. (optional)
$ap_tag : string = null: Filter results by AP tag; either :clientId or :deviceSerial must be jointly specified. (optional)
$band : string = null: Filter results by band (either '2.4' or '5'). (optional)
$ssid : int = null: Filter results by SSID number. (optional)

Tags

Return values

Request —

getOrganizationApiRequestsOverviewRequest()

Create request for operation 'getOrganizationApiRequestsOverview'


    protected
                getOrganizationApiRequestsOverviewRequest(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : Request

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)

Tags

Return values

Request —

getOrganizationApiRequestsRequest()

Create request for operation 'getOrganizationApiRequests'


    protected
                getOrganizationApiRequestsRequest(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $admin_id = null ][, string $path = null ][, string $method = null ][, int $response_code = null ][, string $source_ip = null ]) : Request

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$admin_id : string = null: Filter the results by the ID of the admin who made the API requests (optional)
$path : string = null: Filter the results by the path of the API requests (optional)
$method : string = null: Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE') (optional)
$response_code : int = null: Filter the results by the response code of the API requests (optional)
$source_ip : string = null: Filter the results by the IP address of the originating API request (optional)

Tags

Return values

Request —

getOrganizationApplianceSecurityEventsRequest()

Create request for operation 'getOrganizationApplianceSecurityEvents'


    protected
                getOrganizationApplianceSecurityEventsRequest(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $sort_order = null ]) : Request

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. Data is gathered after the specified t0 value. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 31 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$sort_order : string = null: Sorted order of security events based on event detection time. Order options are 'ascending' or 'descending'. Default is ascending order. (optional)

Tags

Return values

Request —

getOrganizationApplianceUplinkStatusesRequest()

Create request for operation 'getOrganizationApplianceUplinkStatuses'


    protected
                getOrganizationApplianceUplinkStatusesRequest(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : Request

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

Request —

getOrganizationApplianceVpnStatsRequest()

Create request for operation 'getOrganizationApplianceVpnStats'


    protected
                getOrganizationApplianceVpnStatsRequest(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, string $t0 = null ][, string $t1 = null ][, float $timespan = null ]) : Request

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 300. Default is 300. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N_12345678&networkIds[]=L_3456 (optional)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)

Tags

Return values

Request —

getOrganizationApplianceVpnStatusesRequest()

Create request for operation 'getOrganizationApplianceVpnStatuses'


    protected
                getOrganizationApplianceVpnStatusesRequest(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ]) : Request

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 300. Default is 300. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of Meraki network IDs to filter results to contain only specified networks. E.g.: networkIds[]=N_12345678&networkIds[]=L_3456 (optional)

Tags

Return values

Request —

getOrganizationCellularGatewayUplinkStatusesRequest()

Create request for operation 'getOrganizationCellularGatewayUplinkStatuses'


    protected
                getOrganizationCellularGatewayUplinkStatusesRequest(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : Request

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

Request —

getOrganizationConfigurationChangesRequest()

Create request for operation 'getOrganizationConfigurationChanges'


    protected
                getOrganizationConfigurationChangesRequest(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $network_id = null ][, string $admin_id = null ]) : Request

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 365 days after t0. (optional)
$timespan : float = null: 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 365 days. The default is 365 days. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 5000. Default is 5000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_id : string = null: Filters on the given network (optional)
$admin_id : string = null: Filters on the given Admin (optional)

Tags

Return values

Request —

getOrganizationDevicesStatusesRequest()

Create request for operation 'getOrganizationDevicesStatuses'


    protected
                getOrganizationDevicesStatusesRequest(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ]) : Request

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)

Tags

Return values

Request —

getOrganizationDevicesUplinksLossAndLatencyRequest()

Create request for operation 'getOrganizationDevicesUplinksLossAndLatency'


    protected
                getOrganizationDevicesUplinksLossAndLatencyRequest(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $uplink = null ][, string $ip = null ]) : Request

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (optional)
$timespan : float = null: 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 5 minutes. The default is 5 minutes. (optional)
$uplink : string = null: Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)
$ip : string = null: Optional filter for a specific destination IP. Default will return all destination IPs. (optional)

Tags

Return values

Request —

getOrganizationLicensesOverviewRequest()

Create request for operation 'getOrganizationLicensesOverview'


    protected
                getOrganizationLicensesOverviewRequest(string $organization_id) : Request

Parameters

$organization_id : string: (required)

Tags

Return values

Request —

getOrganizationOpenapiSpecRequest()

Create request for operation 'getOrganizationOpenapiSpec'


    protected
                getOrganizationOpenapiSpecRequest(string $organization_id) : Request

Parameters

$organization_id : string: (required)

Tags

Return values

Request —

getOrganizationUplinksStatusesRequest()

Create request for operation 'getOrganizationUplinksStatuses'


    protected
                getOrganizationUplinksStatusesRequest(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, array<string|int, string> $network_ids = null ][, array<string|int, string> $serials = null ][, array<string|int, string> $iccids = null ]) : Request

Parameters

$organization_id : string: (required)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$network_ids : array<string|int, string> = null: A list of network IDs. The returned devices will be filtered to only include these networks. (optional)
$serials : array<string|int, string> = null: A list of serial numbers. The returned devices will be filtered to only include these serials. (optional)
$iccids : array<string|int, string> = null: A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs. (optional)

Tags

Return values

Request —

getOrganizationWebhooksAlertTypesRequest()

Create request for operation 'getOrganizationWebhooksAlertTypes'


    protected
                getOrganizationWebhooksAlertTypesRequest(string $organization_id) : Request

Parameters

$organization_id : string: (required)

Tags

Return values

Request —

getOrganizationWebhooksLogsRequest()

Create request for operation 'getOrganizationWebhooksLogs'


    protected
                getOrganizationWebhooksLogsRequest(string $organization_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $url = null ]) : Request

Parameters

$organization_id : string: (required)
$t0 : string = null: The beginning of the timespan for the data. The maximum lookback period is 90 days from today. (optional)
$t1 : string = null: The end of the timespan for the data. t1 can be a maximum of 31 days after t0. (optional)
$timespan : float = null: 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. (optional)
$per_page : int = null: The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50. (optional)
$starting_after : string = null: 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. (optional)
$ending_before : string = null: 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. (optional)
$url : string = null: The URL the webhook was sent to (optional)

Tags

Return values

Request —

MonitorApi

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

generateDeviceCameraSnapshot()

Parameters

Tags

Return values

generateDeviceCameraSnapshotAsync()

Parameters

Tags

Return values

generateDeviceCameraSnapshotAsyncWithHttpInfo()

Parameters

Tags

Return values

generateDeviceCameraSnapshotWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getDeviceApplianceDhcpSubnets()

Parameters

Tags

Return values

getDeviceApplianceDhcpSubnetsAsync()

Parameters

Tags

Return values

getDeviceApplianceDhcpSubnetsAsyncWithHttpInfo()

Parameters

Tags

Return values

getDeviceApplianceDhcpSubnetsWithHttpInfo()

Parameters

Tags

Return values

getDeviceAppliancePerformance()

Parameters

Tags

Return values

getDeviceAppliancePerformanceAsync()

Parameters

Tags

Return values

getDeviceAppliancePerformanceAsyncWithHttpInfo()

Parameters

Tags

Return values

getDeviceAppliancePerformanceWithHttpInfo()

Parameters

Tags

Return values

getDeviceCameraAnalyticsLive()

Parameters

Tags

Return values

getDeviceCameraAnalyticsLiveAsync()

Parameters

Tags

Return values

getDeviceCameraAnalyticsLiveAsyncWithHttpInfo()

Parameters

Tags

Return values

getDeviceCameraAnalyticsLiveWithHttpInfo()

Parameters

Tags

Return values

getDeviceCameraAnalyticsOverview()

Parameters

Tags