SandboxRule

Sandbox Rule resource for Zscaler Internet Access.

Resource operations

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 SandboxRule
logging.getLogger('zssdk.zia').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 SandboxRule
resource = session.zia.SandboxRule(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 SandboxRule. Set properties on the resource instance, then call create() — this method takes no arguments.

Properties for creation:

Name	Type	Required	Description
access_control	string	No	-
ba_policy_categories	BaPolicyCategoriesEnumCollection	No	-
ba_rule_action	string	No	-
by_threat_score	integer	No	-
cbi_profile	BrowserIsolationProfile	No	-
cbi_profile_id	integer	No	-
default_rule	boolean	No	-
departments	EntityReferenceWrapperCollection	No	-
description	string	No	-
device_groups	EntityReferenceWrapperCollection	No	-
devices	EntityReferenceWrapperCollection	No	-
file_types	FileTypesEnumCollection	No	-
first_time_enable	boolean	No	-
first_time_operation	string	No	-
groups	EntityReferenceWrapperCollection	No	-
labels	EntityReferenceWrapperCollection	No	-
last_modified_by	EntityReference	No	-
last_modified_time	integer	No	-
location_groups	EntityReferenceWrapperCollection	No	-
locations	EntityReferenceWrapperCollection	No	-
ml_action_enabled	boolean	No	-
name	string	No	-
order	integer	No	-
protocols	FileTypeRuleProtocolsEnumCollection	No	-
rank	integer	No	-
state	string	No	-
template_synced_rule_flag	string	No	-
time_windows	EntityReferenceWrapperCollection	No	-
url_categories	stringCollection	No	-
users	EntityReferenceWrapperCollection	No	-
zpa_app_segments	AppSegmentWrapperCollection	No	-

Returns: SandboxRule

Example:

resource = session.zia.SandboxRule()
resource.access_control = "value"
resource.ba_policy_categories = ["value"]
resource.ba_rule_action = "value"
resource.create()
print(f"Created with ID: {resource.id}")

delete()

Deletes a SandboxRule by id. Only the id identifier is required; delete() takes no other arguments.

Example:

resource = session.zia.SandboxRule(id="your-resource-id")
resource.delete()

load()

Fetches an existing SandboxRule by id. Only the id identifier is required; load() takes no other arguments.

Returns: SandboxRule

Example:

resource = session.zia.SandboxRule(id="your-resource-id")
resource.load()
print(resource.name)

update()

Updates an existing SandboxRule. Call load() first, modify properties, then call update() — this method takes no arguments.

Properties for update:

Name	Type	Required	Description
access_control	string	No	-
ba_policy_categories	BaPolicyCategoriesEnumCollection	No	-
ba_rule_action	string	No	-
by_threat_score	integer	No	-
cbi_profile	BrowserIsolationProfile	No	-
cbi_profile_id	integer	No	-
default_rule	boolean	No	-
departments	EntityReferenceWrapperCollection	No	-
description	string	No	-
device_groups	EntityReferenceWrapperCollection	No	-
devices	EntityReferenceWrapperCollection	No	-
file_types	FileTypesEnumCollection	No	-
first_time_enable	boolean	No	-
first_time_operation	string	No	-
groups	EntityReferenceWrapperCollection	No	-
labels	EntityReferenceWrapperCollection	No	-
last_modified_by	EntityReference	No	-
last_modified_time	integer	No	-
location_groups	EntityReferenceWrapperCollection	No	-
locations	EntityReferenceWrapperCollection	No	-
ml_action_enabled	boolean	No	-
name	string	No	-
order	integer	No	-
protocols	FileTypeRuleProtocolsEnumCollection	No	-
rank	integer	No	-
state	string	No	-
template_synced_rule_flag	string	No	-
time_windows	EntityReferenceWrapperCollection	No	-
url_categories	stringCollection	No	-
users	EntityReferenceWrapperCollection	No	-
zpa_app_segments	AppSegmentWrapperCollection	No	-

Returns: SandboxRule

Example:

resource = session.zia.SandboxRule(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

Attributes

Name	Type	Required	Description
access_control	string	No	-
ba_policy_categories	BaPolicyCategoriesEnumCollection	No	-
ba_rule_action	string	No	-
by_threat_score	integer	No	-
cbi_profile	BrowserIsolationProfile	No	-
cbi_profile_id	integer	No	-
default_rule	boolean	No	-
departments	EntityReferenceWrapperCollection	No	-
description	string	No	-
device_groups	EntityReferenceWrapperCollection	No	-
devices	EntityReferenceWrapperCollection	No	-
file_types	FileTypesEnumCollection	No	-
first_time_enable	boolean	No	-
first_time_operation	string	No	-
groups	EntityReferenceWrapperCollection	No	-
id	integer	Yes	-
labels	EntityReferenceWrapperCollection	No	-
last_modified_by	EntityReference	No	-
last_modified_time	integer	No	-
location_groups	EntityReferenceWrapperCollection	No	-
locations	EntityReferenceWrapperCollection	No	-
ml_action_enabled	boolean	No	-
name	string	No	-
order	integer	No	-
protocols	FileTypeRuleProtocolsEnumCollection	No	-
rank	integer	No	-
state	string	No	-
template_synced_rule_flag	string	No	-
time_windows	EntityReferenceWrapperCollection	No	-
url_categories	stringCollection	No	-
users	EntityReferenceWrapperCollection	No	-
zpa_app_segments	AppSegmentWrapperCollection	No	-

Related

• SandboxRule - Data structure definition
• Logging guide - enable verbose logs while debugging this resource