SecurityApi
SecurityApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkApplianceClientSecurityEvents() : object
- Operation getNetworkApplianceClientSecurityEvents
- getNetworkApplianceClientSecurityEventsAsync() : PromiseInterface
- Operation getNetworkApplianceClientSecurityEventsAsync
- getNetworkApplianceClientSecurityEventsAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkApplianceClientSecurityEventsAsyncWithHttpInfo
- getNetworkApplianceClientSecurityEventsWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkApplianceClientSecurityEventsWithHttpInfo
- getNetworkApplianceSecurityEvents() : object
- Operation getNetworkApplianceSecurityEvents
- getNetworkApplianceSecurityEventsAsync() : PromiseInterface
- Operation getNetworkApplianceSecurityEventsAsync
- getNetworkApplianceSecurityEventsAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkApplianceSecurityEventsAsyncWithHttpInfo
- getNetworkApplianceSecurityEventsWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkApplianceSecurityEventsWithHttpInfo
- getNetworkApplianceSecurityIntrusion() : object
- Operation getNetworkApplianceSecurityIntrusion
- getNetworkApplianceSecurityIntrusionAsync() : PromiseInterface
- Operation getNetworkApplianceSecurityIntrusionAsync
- getNetworkApplianceSecurityIntrusionAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkApplianceSecurityIntrusionAsyncWithHttpInfo
- getNetworkApplianceSecurityIntrusionWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkApplianceSecurityIntrusionWithHttpInfo
- getNetworkApplianceSecurityMalware() : object
- Operation getNetworkApplianceSecurityMalware
- getNetworkApplianceSecurityMalwareAsync() : PromiseInterface
- Operation getNetworkApplianceSecurityMalwareAsync
- getNetworkApplianceSecurityMalwareAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkApplianceSecurityMalwareAsyncWithHttpInfo
- getNetworkApplianceSecurityMalwareWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkApplianceSecurityMalwareWithHttpInfo
- getOrganizationApplianceSecurityEvents() : object
- Operation getOrganizationApplianceSecurityEvents
- getOrganizationApplianceSecurityEventsAsync() : PromiseInterface
- Operation getOrganizationApplianceSecurityEventsAsync
- getOrganizationApplianceSecurityEventsAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationApplianceSecurityEventsAsyncWithHttpInfo
- getOrganizationApplianceSecurityEventsWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationApplianceSecurityEventsWithHttpInfo
- getOrganizationApplianceSecurityIntrusion() : object
- Operation getOrganizationApplianceSecurityIntrusion
- getOrganizationApplianceSecurityIntrusionAsync() : PromiseInterface
- Operation getOrganizationApplianceSecurityIntrusionAsync
- getOrganizationApplianceSecurityIntrusionAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationApplianceSecurityIntrusionAsyncWithHttpInfo
- getOrganizationApplianceSecurityIntrusionWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationApplianceSecurityIntrusionWithHttpInfo
- updateNetworkApplianceSecurityIntrusion() : object
- Operation updateNetworkApplianceSecurityIntrusion
- updateNetworkApplianceSecurityIntrusionAsync() : PromiseInterface
- Operation updateNetworkApplianceSecurityIntrusionAsync
- updateNetworkApplianceSecurityIntrusionAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkApplianceSecurityIntrusionAsyncWithHttpInfo
- updateNetworkApplianceSecurityIntrusionWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkApplianceSecurityIntrusionWithHttpInfo
- updateNetworkApplianceSecurityMalware() : object
- Operation updateNetworkApplianceSecurityMalware
- updateNetworkApplianceSecurityMalwareAsync() : PromiseInterface
- Operation updateNetworkApplianceSecurityMalwareAsync
- updateNetworkApplianceSecurityMalwareAsyncWithHttpInfo() : PromiseInterface
- Operation updateNetworkApplianceSecurityMalwareAsyncWithHttpInfo
- updateNetworkApplianceSecurityMalwareWithHttpInfo() : array<string|int, mixed>
- Operation updateNetworkApplianceSecurityMalwareWithHttpInfo
- updateOrganizationApplianceSecurityIntrusion() : object
- Operation updateOrganizationApplianceSecurityIntrusion
- updateOrganizationApplianceSecurityIntrusionAsync() : PromiseInterface
- Operation updateOrganizationApplianceSecurityIntrusionAsync
- updateOrganizationApplianceSecurityIntrusionAsyncWithHttpInfo() : PromiseInterface
- Operation updateOrganizationApplianceSecurityIntrusionAsyncWithHttpInfo
- updateOrganizationApplianceSecurityIntrusionWithHttpInfo() : array<string|int, mixed>
- Operation updateOrganizationApplianceSecurityIntrusionWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkApplianceClientSecurityEventsRequest() : Request
- Create request for operation 'getNetworkApplianceClientSecurityEvents'
- getNetworkApplianceSecurityEventsRequest() : Request
- Create request for operation 'getNetworkApplianceSecurityEvents'
- getNetworkApplianceSecurityIntrusionRequest() : Request
- Create request for operation 'getNetworkApplianceSecurityIntrusion'
- getNetworkApplianceSecurityMalwareRequest() : Request
- Create request for operation 'getNetworkApplianceSecurityMalware'
- getOrganizationApplianceSecurityEventsRequest() : Request
- Create request for operation 'getOrganizationApplianceSecurityEvents'
- getOrganizationApplianceSecurityIntrusionRequest() : Request
- Create request for operation 'getOrganizationApplianceSecurityIntrusion'
- updateNetworkApplianceSecurityIntrusionRequest() : Request
- Create request for operation 'updateNetworkApplianceSecurityIntrusion'
- updateNetworkApplianceSecurityMalwareRequest() : Request
- Create request for operation 'updateNetworkApplianceSecurityMalware'
- updateOrganizationApplianceSecurityIntrusionRequest() : Request
- Create request for operation 'updateOrganizationApplianceSecurityIntrusion'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__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)
getNetworkApplianceSecurityIntrusion()
Operation getNetworkApplianceSecurityIntrusion
public
getNetworkApplianceSecurityIntrusion(string $network_id) : object
Returns all supported intrusion settings for an MX network
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkApplianceSecurityIntrusionAsync()
Operation getNetworkApplianceSecurityIntrusionAsync
public
getNetworkApplianceSecurityIntrusionAsync(string $network_id) : PromiseInterface
Returns all supported intrusion settings for an MX network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkApplianceSecurityIntrusionAsyncWithHttpInfo()
Operation getNetworkApplianceSecurityIntrusionAsyncWithHttpInfo
public
getNetworkApplianceSecurityIntrusionAsyncWithHttpInfo(string $network_id) : PromiseInterface
Returns all supported intrusion settings for an MX network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkApplianceSecurityIntrusionWithHttpInfo()
Operation getNetworkApplianceSecurityIntrusionWithHttpInfo
public
getNetworkApplianceSecurityIntrusionWithHttpInfo(string $network_id) : array<string|int, mixed>
Returns all supported intrusion settings for an MX network
Parameters
- $network_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkApplianceSecurityMalware()
Operation getNetworkApplianceSecurityMalware
public
getNetworkApplianceSecurityMalware(string $network_id) : object
Returns all supported malware settings for an MX network
Parameters
- $network_id : string
-
network_id (required)
Tags
Return values
object —getNetworkApplianceSecurityMalwareAsync()
Operation getNetworkApplianceSecurityMalwareAsync
public
getNetworkApplianceSecurityMalwareAsync(string $network_id) : PromiseInterface
Returns all supported malware settings for an MX network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkApplianceSecurityMalwareAsyncWithHttpInfo()
Operation getNetworkApplianceSecurityMalwareAsyncWithHttpInfo
public
getNetworkApplianceSecurityMalwareAsyncWithHttpInfo(string $network_id) : PromiseInterface
Returns all supported malware settings for an MX network
Parameters
- $network_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkApplianceSecurityMalwareWithHttpInfo()
Operation getNetworkApplianceSecurityMalwareWithHttpInfo
public
getNetworkApplianceSecurityMalwareWithHttpInfo(string $network_id) : array<string|int, mixed>
Returns all supported malware settings for an MX network
Parameters
- $network_id : string
-
(required)
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)
getOrganizationApplianceSecurityIntrusion()
Operation getOrganizationApplianceSecurityIntrusion
public
getOrganizationApplianceSecurityIntrusion(string $organization_id) : object
Returns all supported intrusion settings for an organization
Parameters
- $organization_id : string
-
organization_id (required)
Tags
Return values
object —getOrganizationApplianceSecurityIntrusionAsync()
Operation getOrganizationApplianceSecurityIntrusionAsync
public
getOrganizationApplianceSecurityIntrusionAsync(string $organization_id) : PromiseInterface
Returns all supported intrusion settings for an organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationApplianceSecurityIntrusionAsyncWithHttpInfo()
Operation getOrganizationApplianceSecurityIntrusionAsyncWithHttpInfo
public
getOrganizationApplianceSecurityIntrusionAsyncWithHttpInfo(string $organization_id) : PromiseInterface
Returns all supported intrusion settings for an organization
Parameters
- $organization_id : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationApplianceSecurityIntrusionWithHttpInfo()
Operation getOrganizationApplianceSecurityIntrusionWithHttpInfo
public
getOrganizationApplianceSecurityIntrusionWithHttpInfo(string $organization_id) : array<string|int, mixed>
Returns all supported intrusion settings 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)
updateNetworkApplianceSecurityIntrusion()
Operation updateNetworkApplianceSecurityIntrusion
public
updateNetworkApplianceSecurityIntrusion(string $network_id[, UpdateNetworkApplianceSecurityIntrusion $update_network_appliance_security_intrusion = null ]) : object
Set the supported intrusion settings for an MX network
Parameters
- $network_id : string
-
network_id (required)
- $update_network_appliance_security_intrusion : UpdateNetworkApplianceSecurityIntrusion = null
-
update_network_appliance_security_intrusion (optional)
Tags
Return values
object —updateNetworkApplianceSecurityIntrusionAsync()
Operation updateNetworkApplianceSecurityIntrusionAsync
public
updateNetworkApplianceSecurityIntrusionAsync(string $network_id[, UpdateNetworkApplianceSecurityIntrusion $update_network_appliance_security_intrusion = null ]) : PromiseInterface
Set the supported intrusion settings for an MX network
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_security_intrusion : UpdateNetworkApplianceSecurityIntrusion = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkApplianceSecurityIntrusionAsyncWithHttpInfo()
Operation updateNetworkApplianceSecurityIntrusionAsyncWithHttpInfo
public
updateNetworkApplianceSecurityIntrusionAsyncWithHttpInfo(string $network_id[, UpdateNetworkApplianceSecurityIntrusion $update_network_appliance_security_intrusion = null ]) : PromiseInterface
Set the supported intrusion settings for an MX network
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_security_intrusion : UpdateNetworkApplianceSecurityIntrusion = null
-
(optional)
Tags
Return values
PromiseInterface —updateNetworkApplianceSecurityIntrusionWithHttpInfo()
Operation updateNetworkApplianceSecurityIntrusionWithHttpInfo
public
updateNetworkApplianceSecurityIntrusionWithHttpInfo(string $network_id[, UpdateNetworkApplianceSecurityIntrusion $update_network_appliance_security_intrusion = null ]) : array<string|int, mixed>
Set the supported intrusion settings for an MX network
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_security_intrusion : UpdateNetworkApplianceSecurityIntrusion = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateNetworkApplianceSecurityMalware()
Operation updateNetworkApplianceSecurityMalware
public
updateNetworkApplianceSecurityMalware(string $network_id, UpdateNetworkApplianceSecurityMalware $update_network_appliance_security_malware) : object
Set the supported malware settings for an MX network
Parameters
- $network_id : string
-
network_id (required)
- $update_network_appliance_security_malware : UpdateNetworkApplianceSecurityMalware
-
update_network_appliance_security_malware (required)
Tags
Return values
object —updateNetworkApplianceSecurityMalwareAsync()
Operation updateNetworkApplianceSecurityMalwareAsync
public
updateNetworkApplianceSecurityMalwareAsync(string $network_id, UpdateNetworkApplianceSecurityMalware $update_network_appliance_security_malware) : PromiseInterface
Set the supported malware settings for an MX network
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_security_malware : UpdateNetworkApplianceSecurityMalware
-
(required)
Tags
Return values
PromiseInterface —updateNetworkApplianceSecurityMalwareAsyncWithHttpInfo()
Operation updateNetworkApplianceSecurityMalwareAsyncWithHttpInfo
public
updateNetworkApplianceSecurityMalwareAsyncWithHttpInfo(string $network_id, UpdateNetworkApplianceSecurityMalware $update_network_appliance_security_malware) : PromiseInterface
Set the supported malware settings for an MX network
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_security_malware : UpdateNetworkApplianceSecurityMalware
-
(required)
Tags
Return values
PromiseInterface —updateNetworkApplianceSecurityMalwareWithHttpInfo()
Operation updateNetworkApplianceSecurityMalwareWithHttpInfo
public
updateNetworkApplianceSecurityMalwareWithHttpInfo(string $network_id, UpdateNetworkApplianceSecurityMalware $update_network_appliance_security_malware) : array<string|int, mixed>
Set the supported malware settings for an MX network
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_security_malware : UpdateNetworkApplianceSecurityMalware
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateOrganizationApplianceSecurityIntrusion()
Operation updateOrganizationApplianceSecurityIntrusion
public
updateOrganizationApplianceSecurityIntrusion(string $organization_id, UpdateOrganizationApplianceSecurityIntrusion $update_organization_appliance_security_intrusion) : object
Sets supported intrusion settings for an organization
Parameters
- $organization_id : string
-
organization_id (required)
- $update_organization_appliance_security_intrusion : UpdateOrganizationApplianceSecurityIntrusion
-
update_organization_appliance_security_intrusion (required)
Tags
Return values
object —updateOrganizationApplianceSecurityIntrusionAsync()
Operation updateOrganizationApplianceSecurityIntrusionAsync
public
updateOrganizationApplianceSecurityIntrusionAsync(string $organization_id, UpdateOrganizationApplianceSecurityIntrusion $update_organization_appliance_security_intrusion) : PromiseInterface
Sets supported intrusion settings for an organization
Parameters
- $organization_id : string
-
(required)
- $update_organization_appliance_security_intrusion : UpdateOrganizationApplianceSecurityIntrusion
-
(required)
Tags
Return values
PromiseInterface —updateOrganizationApplianceSecurityIntrusionAsyncWithHttpInfo()
Operation updateOrganizationApplianceSecurityIntrusionAsyncWithHttpInfo
public
updateOrganizationApplianceSecurityIntrusionAsyncWithHttpInfo(string $organization_id, UpdateOrganizationApplianceSecurityIntrusion $update_organization_appliance_security_intrusion) : PromiseInterface
Sets supported intrusion settings for an organization
Parameters
- $organization_id : string
-
(required)
- $update_organization_appliance_security_intrusion : UpdateOrganizationApplianceSecurityIntrusion
-
(required)
Tags
Return values
PromiseInterface —updateOrganizationApplianceSecurityIntrusionWithHttpInfo()
Operation updateOrganizationApplianceSecurityIntrusionWithHttpInfo
public
updateOrganizationApplianceSecurityIntrusionWithHttpInfo(string $organization_id, UpdateOrganizationApplianceSecurityIntrusion $update_organization_appliance_security_intrusion) : array<string|int, mixed>
Sets supported intrusion settings for an organization
Parameters
- $organization_id : string
-
(required)
- $update_organization_appliance_security_intrusion : UpdateOrganizationApplianceSecurityIntrusion
-
(required)
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 —getNetworkApplianceSecurityIntrusionRequest()
Create request for operation 'getNetworkApplianceSecurityIntrusion'
protected
getNetworkApplianceSecurityIntrusionRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
Tags
Return values
Request —getNetworkApplianceSecurityMalwareRequest()
Create request for operation 'getNetworkApplianceSecurityMalware'
protected
getNetworkApplianceSecurityMalwareRequest(string $network_id) : Request
Parameters
- $network_id : string
-
(required)
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 —getOrganizationApplianceSecurityIntrusionRequest()
Create request for operation 'getOrganizationApplianceSecurityIntrusion'
protected
getOrganizationApplianceSecurityIntrusionRequest(string $organization_id) : Request
Parameters
- $organization_id : string
-
(required)
Tags
Return values
Request —updateNetworkApplianceSecurityIntrusionRequest()
Create request for operation 'updateNetworkApplianceSecurityIntrusion'
protected
updateNetworkApplianceSecurityIntrusionRequest(string $network_id[, UpdateNetworkApplianceSecurityIntrusion $update_network_appliance_security_intrusion = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_security_intrusion : UpdateNetworkApplianceSecurityIntrusion = null
-
(optional)
Tags
Return values
Request —updateNetworkApplianceSecurityMalwareRequest()
Create request for operation 'updateNetworkApplianceSecurityMalware'
protected
updateNetworkApplianceSecurityMalwareRequest(string $network_id, UpdateNetworkApplianceSecurityMalware $update_network_appliance_security_malware) : Request
Parameters
- $network_id : string
-
(required)
- $update_network_appliance_security_malware : UpdateNetworkApplianceSecurityMalware
-
(required)
Tags
Return values
Request —updateOrganizationApplianceSecurityIntrusionRequest()
Create request for operation 'updateOrganizationApplianceSecurityIntrusion'
protected
updateOrganizationApplianceSecurityIntrusionRequest(string $organization_id, UpdateOrganizationApplianceSecurityIntrusion $update_organization_appliance_security_intrusion) : Request
Parameters
- $organization_id : string
-
(required)
- $update_organization_appliance_security_intrusion : UpdateOrganizationApplianceSecurityIntrusion
-
(required)