predefined_ip_based_apps¶

The following methods allow for interaction with the ZCC Predefined IP-based Apps API endpoints.

Methods are accessible via zcc.predefined_ip_based_apps

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

Bases: APIClient

get_predefined_ip_based_app(app_id)¶

Retrieves the predefined IP-based application using app ID.

Parameters:: app_id (str) – The unique identifier of the predefined IP-based application.
Returns:: Retrieves the predefined IP-based application.
Return type:: list

Examples

Prints the predefined IP-based application:

>>> app, _, err = client.zcc.predefined_ip_based_apps.get_predefined_ip_based_app('1234567890')
>>> if err:
...     print(f"Error listing predefined IP-based application: {err}")
...     return
... print(app.as_dict())

get_predefined_ip_based_apps()¶

Retrieves the list of predefined IP-based applications.

Parameters:

query_params (dict, optional) –

A dictionary containing supported filters.

[query_params.page] {str}: Specifies the page offset.

[query_params.page_size] {str}: Specifies the page size. The default size is 50.

[query_params.search] {str}: The search string used to match against the policies.

Returns:

Retrieves the list of predefined IP-based applications.

Return type:

list

Examples

Prints all predefined IP-based applications:

>>> apps_list, _, err = client.zcc.predefined_ip_based_apps.get_predefined_ip_based_apps()
>>> if err:
...     print(f"Error listing predefined IP-based applications: {err}")
...     return
... for app in apps_list:
...     print(app.as_dict())