IpDestinationGroup
Ip Destination Group resource for Zscaler Cloud & Branch Connector.
This resource supports the following standard methods: create(), load(), update(), delete(). They operate on the instance state — set properties with dot notation, then call the method with no arguments.
Quick Start
import zssdk
import logging
# Enable debug logging for IpDestinationGroup
logging.getLogger('zssdk.ztw').setLevel(logging.DEBUG)
logging.basicConfig(level=logging.DEBUG)
session = zssdk.Session(
vanity_domain="your-vanity-domain",
client_id="your-client-id",
client_secret="your-client-secret",
)
# Get a specific IpDestinationGroup
resource = session.ztw.IpDestinationGroup(id="your-resource-id")
resource.load()
print(resource)
# Debug output shows HTTP request/response details
Identifiers
| Name | Type | Description |
|---|---|---|
id | string | Unique identifier |
Actions
create()
Creates a new IpDestinationGroup. Set properties on the resource instance, then call create() — this method takes no arguments.
Properties for creation:
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | - |
type | string | No | - |
addresses | stringCollection | No | - |
description | string | No | - |
creator_context | string | No | - |
ip_categories | stringCollection | No | - |
countries | DestCountriesEnumCollection | No | - |
is_non_editable | boolean | No | - |
is_predefined | boolean | No | - |
Returns: IpDestinationGroup
Example:
resource = session.ztw.IpDestinationGroup()
resource.name = "example-name"
resource.create()
print(f"Created with ID: {resource.id}")
delete()
Deletes a IpDestinationGroup by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.ztw.IpDestinationGroup(id="your-resource-id")
resource.delete()
load()
Fetches an existing IpDestinationGroup by id. Only the id identifier is required; load() takes no other arguments.
Returns: IpDestinationGroup
Example:
resource = session.ztw.IpDestinationGroup(id="your-resource-id")
resource.load()
print(resource.name)
update()
Updates an existing IpDestinationGroup. Call load() first, modify properties, then call update() — this method takes no arguments.
Properties for update:
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | - |
type | string | No | - |
addresses | stringCollection | No | - |
description | string | No | - |
creator_context | string | No | - |
ip_categories | stringCollection | No | - |
countries | DestCountriesEnumCollection | No | - |
is_non_editable | boolean | No | - |
is_predefined | boolean | No | - |
Returns: IpDestinationGroup
Example:
resource = session.ztw.IpDestinationGroup(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | - |
name | string | Yes | - |
type | string | No | - |
addresses | stringCollection | No | - |
description | string | No | - |
creator_context | string | No | - |
ip_categories | stringCollection | No | - |
countries | DestCountriesEnumCollection | No | - |
is_non_editable | boolean | No | - |
is_predefined | boolean | No | - |
Related
- IpDestinationGroup - Data structure definition
- Logging guide - enable verbose logs while debugging this resource