logs¶

The following methods allow for interaction with the ZTB Logs API endpoints. Includes visibility chart data retrieval (query_type, search_criteria, search_text, site, network, subnet, osgroup parameters).

Methods are accessible via ztb.logs

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 LogsAPI¶

Bases: APIClient

Client for the ZTB Logs resource.

Provides operations for retrieving log data and visibility chart data in the Zero Trust Branch API. Endpoint: /api/logs.

get_visibility_chart(query_params=None)¶

Get data for visibility chart.

Parameters:: query_params (dict, optional) – Map of query parameters. [query_params.query_type] (str): Required. Type of query (e.g. sites). [query_params.search_criteria] (str): Search criteria. [query_params.search_text] (str): Text to search for. [query_params.site] (str): Site filter. [query_params.network] (str): Network filter. [query_params.subnet] (str): Subnet filter. [query_params.osgroup] (str): OS group filter.
Returns:: (VisibilityChartData instance, Response, error).
Return type:: tuple

Examples

>>> chart_data, _, err = client.ztb.logs.get_visibility_chart(
...     query_params={"query_type": "sites"}
... )
>>> if err:
...     print(f"Error: {err}")
...     return
>>> for item in chart_data.data:
...     print(item.type, item.id)