app_connector_config¶

The following methods allow for interaction with the ZTB App Connector Config API endpoints.

Methods are accessible via ztb.app_connector_config

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

Bases: APIClient

Client for the ZTB App Connector Config resource.

Provides CRUD operations for app connector config in the Zero Trust Branch API.

create_app_connector_config(**kwargs)¶

Create a new app connector config.

Parameters:: **kwargs – App connector config creation fields.
Returns:: Tuple of (AppConnectorConfigResult instance, response, error).

Examples

>>> app_connector_config, response, error = client.ztb.app_connector_config.create_app_connector_config(name="test")

delete_app_connector(cluster_id)¶

Delete AppConnector config.

Parameters:: cluster_id (str) – The unique identifier of the Cluster.
Returns:: A tuple containing the response object and error (if any).
Return type:: tuple

Examples

Delete a app connector config:

>>> _, _, error = client.ztb.app_connector_config.delete_app_connector('73459')
>>> if error:
...     print(f"Error deleting AppConnector config: {error}")
...     return
... print(f"AppConnector config with ID {'73459' deleted successfully.")

get_app_connector_config(cluster_id)¶

Get a single app connector config by cluster ID.

Parameters:: cluster_id – The cluster identifier.
Returns:: Tuple of (AppConnectorConfigResult instance, response, error).

Examples

>>> app_connector_config, response, error = client.ztb.app_connector_config.get_app_connector_config("abc-123")