app_zones

The following methods allow for interaction with the ZMS App Zones API endpoints.

Methods are accessible via zms.app_zones

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 AppZonesAPI

Bases: APIClient

A Client object for the ZMS App Zones domain.

Provides access to app zone operations including: - List app zones with filtering, ordering, and pagination

list_app_zones(customer_id, page_num=1, page_size=20, filter_by=None, order_by=None)

Get app zones for a given customer with optional filtering.

Parameters:

  • customer_id – The customer ID.

  • page_num – Page number (default 1).

  • page_size – Number of items per page (default 20).

  • filter_by – Filter options using AppZoneFilter.

  • order_by – Ordering options using AppZoneQueryOrderBy.

Returns:

(app_zones_connection dict, response, error)

Return type:

tuple

Examples

List app zones:

>>> result, _, err = client.zms.app_zones.list_app_zones(
...     customer_id="123456789"
... )
>>> if err:
...     print(err)
>>> for zone in result.get("nodes", []):
...     print(zone.get("appZoneName"))