cyber_security

The following methods allow for interaction with the Z-Insights Cyber Security Analytics API.

Methods are accessible via zinsights.cyber_security

Copyright (c) 2023, Zscaler Inc.

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class CyberSecurityAPI

Bases: APIClient

A Client object for the Z-Insights CYBER_SECURITY domain.

Cybersecurity Insights provides a unified real-time visibility into critical security incidents and policy actions to understand the security efficacy of layered defense across Malware Protection, Advanced Threat Protection (ATP), Sandbox, Firewall, and Isolation for your organization.

get_incidents(start_time, end_time, categorize_by=None, limit=None)

Get cybersecurity incidents data grouped by category.

Note: This query returns nested entries. Each entry may have sub-entries.

Parameters:

  • start_time – Start time in epoch milliseconds.

  • end_time – End time in epoch milliseconds.

  • categorize_by – List of categories to group by. Options: - THREAT_CATEGORY_ID - APP_ID - USER_ID - TIME - SRC_COUNTRY Default: [“THREAT_CATEGORY_ID”]

  • limit – Maximum number of entries to return.

Returns:

(entries_list, response, error)

Return type:

tuple

Examples

>>> entries, _, err = client.zinsights.cyber_security.get_incidents(
...     start_time=start_time,
...     end_time=end_time,
...     categorize_by=["THREAT_CATEGORY_ID"],
...     limit=10
... )
get_incidents_by_location(start_time, end_time, categorize_by='LOCATION_ID', limit=None)

Get cybersecurity incidents grouped by location or other dimension.

Parameters:

  • start_time – Start time in epoch milliseconds.

  • end_time – End time in epoch milliseconds.

  • categorize_by – Category to group by. Options: - LOCATION_ID (default) - APP_ID - USER_ID - DEPARTMENT_ID

  • limit – Maximum number of entries to return.

Returns:

(entries_list, response, error)

Return type:

tuple

Examples

>>> entries, _, err = client.zinsights.cyber_security.get_incidents_by_location(
...     start_time=start_time,
...     end_time=end_time,
...     categorize_by="LOCATION_ID",
...     limit=10
... )