ZpaGateway
Zpa Gateway resource for Zscaler Internet Access.
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 ZpaGateway
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 ZpaGateway
resource = session.zia.ZpaGateway(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 ZpaGateway. Set properties on the resource instance, then call create() — this method takes no arguments.
Properties for creation:
| Name | Type | Required | Description |
|---|---|---|---|
description | string | No | - |
id | integer | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
name | string | No | - |
read_only | boolean | No | - |
type | string | No | - |
zpa_app_segments | EntityReferenceWrapperCollection | No | - |
zpa_server_group | EntityReference | No | - |
Returns: ZpaGateway
Example:
resource = session.zia.ZpaGateway()
resource.description = "Resource description"
resource.id = 3600
resource.last_modified_by = {"association_time": 3600, "deleted": True, "extensions": {"key1": "value", "key2": "value"}, "external_id": "resource-id"}
resource.create()
print(f"Created with ID: {resource.id}")
delete()
Deletes a ZpaGateway by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.zia.ZpaGateway(id="your-resource-id")
resource.delete()
load()
Fetches an existing ZpaGateway by id. Only the id identifier is required; load() takes no other arguments.
Returns: ZpaGateway
Example:
resource = session.zia.ZpaGateway(id="your-resource-id")
resource.load()
print(resource.name)
update()
Updates an existing ZpaGateway. Call load() first, modify properties, then call update() — this method takes no arguments.
Properties for update:
| Name | Type | Required | Description |
|---|---|---|---|
description | string | No | - |
id | integer | Yes | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
name | string | No | - |
read_only | boolean | No | - |
type | string | No | - |
zpa_app_segments | EntityReferenceWrapperCollection | No | - |
zpa_server_group | EntityReference | No | - |
Returns: ZpaGateway
Example:
resource = session.zia.ZpaGateway(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
description | string | No | - |
id | integer | No | - |
last_modified_by | EntityReference | No | - |
last_modified_time | integer | No | - |
name | string | No | - |
read_only | boolean | No | - |
type | string | No | - |
zpa_app_segments | EntityReferenceWrapperCollection | No | - |
zpa_server_group | EntityReference | No | - |
Related
- ZpaGateway - Data structure definition
- Logging guide - enable verbose logs while debugging this resource