branch_connectors¶

The following methods allow for interaction with the ZPA Branch Connectors API endpoints.

Methods are accessible via zpa.branch_connectors

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

Bases: APIClient

A Client object for the Branch Connectors resource.

list_branch_connectors(query_params=None)¶

Get all BranchConnectors configured for a given customer.

Parameters:

{dict} (query_params) –

Map of query parameters for the request.

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

[query_params.page_size] {str}: Specifies the page size.: If not provided, the default page size is 20. The max page size is 500.

[query_params.search] {str}: Search string for filtering results.

Returns:

A tuple containing (list of Branch Connector instances, Response, error)

Return type:

Tuple

Examples

>>> connector_list, _, err = client.zpa.branch_connectors.list_branch_connectors(
... query_params={'search': 'BRConnector01', 'page': '1', 'page_size': '100'})
... if err:
...     print(f"Error listing branch connector: {err}")
...     return
... print(f"Total branch connector found: {len(connector_list)}")
... for connector in connector_list:
...     print(connector.as_dict())