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 —

getConfig()


    public
                getConfig() : Configuration

Return values

Configuration —

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)

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)

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)

createHttpClientOption()

Create http client option


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

Tags

Return values

array<string|int, mixed> —

of http client options

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 —

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 —

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 —

EventsApi

Tags

Table of Contents

Properties

$client

$config

$headerSelector

Methods

__construct()

Parameters

Return values

getConfig()

Return values

getNetworkApplianceClientSecurityEvents()

Parameters

Tags

Return values

getNetworkApplianceClientSecurityEventsAsync()

Parameters

Tags

Return values

getNetworkApplianceClientSecurityEventsAsyncWithHttpInfo()

Parameters

Tags

Return values

getNetworkApplianceClientSecurityEventsWithHttpInfo()

Parameters

Tags

Return values

getNetworkApplianceSecurityEvents()

Parameters

Tags

Return values

getNetworkApplianceSecurityEventsAsync()

Parameters

Tags

Return values

getNetworkApplianceSecurityEventsAsyncWithHttpInfo()

Parameters

Tags

Return values

getNetworkApplianceSecurityEventsWithHttpInfo()

Parameters

Tags

Return values

getNetworkEvents()

Parameters

Tags

Return values

getNetworkEventsAsync()

Parameters

Tags

Return values

getNetworkEventsAsyncWithHttpInfo()

Parameters

Tags

Return values

getNetworkEventsEventTypes()

Parameters

Tags

Return values

getNetworkEventsEventTypesAsync()

Parameters

Tags

Return values

getNetworkEventsEventTypesAsyncWithHttpInfo()

Parameters

Tags

Return values

getNetworkEventsEventTypesWithHttpInfo()

Parameters

Tags

Return values

getNetworkEventsWithHttpInfo()

Parameters

Tags

Return values

getOrganizationApplianceSecurityEvents()

Parameters

Tags