ServiceEdge
Service Edge resource for Zscaler Private Access V1.
Resource operations
This resource supports the following standard methods: load(), update(), delete(). They operate on the instance state — set properties with dot notation, then call the method with no arguments. Any other action listed below is a custom action that takes explicit keyword arguments and returns a value.
Quick Start
import zssdk
import logging
# Enable debug logging for ServiceEdge
logging.getLogger('zssdk.zpa').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 ServiceEdge
resource = session.zpa.ServiceEdge(id="your-resource-id")
resource.load()
print(resource)
# Debug output shows HTTP request/response details
Identifiers
| Name | Type | Description |
|---|---|---|
id | string | Unique identifier |
Actions
bulk_delete_service_edge()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | No | - |
microtenant_id | long | No | - |
ids | int64Collection | Yes | - |
Returns: EmptyModel
Example:
resource = session.zpa.ServiceEdge()
result = resource.bulk_delete_service_edge(ids=[3600])
print(result)
delete()
Deletes a ServiceEdge by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.zpa.ServiceEdge(id="your-resource-id")
resource.delete()
get_service_edge_schedule()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | Yes | - |
microtenant_id | long | No | - |
Returns: ScheduledConfig
Example:
resource = session.zpa.ServiceEdge()
result = resource.get_service_edge_schedule(customer_id=3600)
print(result)
load()
Fetches an existing ServiceEdge by id. Only the id identifier is required; load() takes no other arguments.
Returns: ServiceEdge
Example:
resource = session.zpa.ServiceEdge(id="your-resource-id")
resource.load()
print(resource.name)
save_service_edge_schedule()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | Yes | - |
microtenant_id | long | No | - |
id | long | No | - |
frequency_interval | integer | No | - |
frequency | string | No | - |
enabled | boolean | No | - |
delete_disabled | boolean | No | - |
Example:
resource = session.zpa.ServiceEdge()
result = resource.save_service_edge_schedule(customer_id=3600)
print(result)
update()
Updates an existing ServiceEdge. Call load() first, modify properties, then call update() — this method takes no arguments.
Properties for update:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | No | - |
microtenant_id | long | No | - |
id | long | No | - |
modified_time | integer | No | - |
creation_time | integer | No | - |
modified_by | long | No | - |
name | string | Yes | - |
microtenant_name | string | No | - |
restriction_type | string | No | - |
description | string | No | - |
fingerprint | string | No | - |
issued_cert_id | long | No | - |
enabled | boolean | No | - |
ip_acl | stringCollection | No | - |
listen_ips | stringCollection | No | - |
publish_ips | stringCollection | No | - |
publish_ipv6 | boolean | No | - |
private_broker_version | ServiceEdgeVersion | No | - |
provisioning_key_id | long | No | - |
provisioning_key_name | string | No | - |
service_edge_group_id | string | No | - |
service_edge_group_name | string | No | - |
enrollment_cert | EmptyModel | No | - |
latitude | string | No | - |
longitude | string | No | - |
location | string | No | - |
expected_version | string | No | - |
current_version | string | No | - |
previous_version | string | No | - |
last_upgrade_time | long | No | - |
expected_upgrade_time | long | No | - |
upgrade_status | string | No | - |
control_channel_status | string | No | - |
upgrade_attempt | integer | No | - |
ctrl_broker_name | string | No | - |
last_broker_connect_time | long | No | - |
last_broker_connect_time_duration | string | No | - |
last_broker_disconnect_time | long | No | - |
last_broker_disconnect_time_duration | string | No | - |
private_ip | string | No | - |
public_ip | string | No | - |
platform | string | No | - |
runtime_OS | string | No | - |
application_start_time | long | No | - |
sarge_version | string | No | - |
platform_detail | string | No | - |
expected_sarge_version | string | No | - |
sarge_upgrade_status | string | No | - |
os_upgrade_status | string | No | - |
last_sarge_upgrade_time | long | No | - |
last_OS_upgrade_time | long | No | - |
sarge_upgrade_attempt | integer | No | - |
platform_version | string | No | - |
os_upgrade_enabled | boolean | No | - |
zpn_sub_module_upgrade_list | SubModuleUpgradeWrapperCollection | No | - |
read_only | boolean | No | - |
zscaler_managed | boolean | No | - |
name_without_trim | string | No | - |
Example:
resource = session.zpa.ServiceEdge(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()
update_service_edge_schedule()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
customer_id | long | Yes | - |
microtenant_id | long | No | - |
id | long | Yes | - |
frequency_interval | integer | No | - |
frequency | string | No | - |
enabled | boolean | No | - |
delete_disabled | boolean | No | - |
Example:
resource = session.zpa.ServiceEdge(id="your-resource-id")
result = resource.update_service_edge_schedule(customer_id=3600, id=3600)
print(result)
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
id | long | No | - |
modified_time | integer | No | - |
creation_time | integer | No | - |
modified_by | long | No | - |
name | string | Yes | - |
microtenant_id | long | No | - |
microtenant_name | string | No | - |
restriction_type | string | No | - |
description | string | No | - |
fingerprint | string | No | - |
issued_cert_id | long | No | - |
enabled | boolean | No | - |
ip_acl | stringCollection | No | - |
listen_ips | stringCollection | No | - |
publish_ips | stringCollection | No | - |
publish_ipv6 | boolean | No | - |
private_broker_version | ServiceEdgeVersion | No | - |
provisioning_key_id | long | No | - |
provisioning_key_name | string | No | - |
service_edge_group_id | string | No | - |
service_edge_group_name | string | No | - |
enrollment_cert | EmptyModel | No | - |
latitude | string | No | - |
longitude | string | No | - |
location | string | No | - |
expected_version | string | No | - |
current_version | string | No | - |
previous_version | string | No | - |
last_upgrade_time | long | No | - |
expected_upgrade_time | long | No | - |
upgrade_status | string | No | - |
control_channel_status | string | No | - |
upgrade_attempt | integer | No | - |
ctrl_broker_name | string | No | - |
last_broker_connect_time | long | No | - |
last_broker_connect_time_duration | string | No | - |
last_broker_disconnect_time | long | No | - |
last_broker_disconnect_time_duration | string | No | - |
private_ip | string | No | - |
public_ip | string | No | - |
platform | string | No | - |
runtime_OS | string | No | - |
application_start_time | long | No | - |
sarge_version | string | No | - |
platform_detail | string | No | - |
expected_sarge_version | string | No | - |
sarge_upgrade_status | string | No | - |
os_upgrade_status | string | No | - |
last_sarge_upgrade_time | long | No | - |
last_OS_upgrade_time | long | No | - |
sarge_upgrade_attempt | integer | No | - |
platform_version | string | No | - |
os_upgrade_enabled | boolean | No | - |
zpn_sub_module_upgrade_list | SubModuleUpgradeWrapperCollection | No | - |
read_only | boolean | No | - |
zscaler_managed | boolean | No | - |
name_without_trim | string | No | - |
version | ComponentLevelVersion | No | - |
Related
- ServiceEdge - Data structure definition
- Logging guide - enable verbose logs while debugging this resource