EcGateway

Ec Gateway resource for Zscaler Cloud & Branch Connector.

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 EcGateway
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 EcGateway
resource = session.ztw.EcGateway(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 EcGateway. Set properties on the resource instance, then call create() — this method takes no arguments.

Properties for creation:

Name	Type	Required	Description
description	string	No	-
fail_closed	boolean	No	-
last_modified_by	EntityReference	No	-
last_modified_time	integer	No	-
manual_primary	string	No	-
manual_secondary	string	No	-
name	string	No	-
primary_type	string	No	-
secondary_type	string	No	-
subcloud_primary	EntityReference	No	-
subcloud_secondary	EntityReference	No	-
type	string	Yes	-

Returns: EcGateway

Example:

resource = session.ztw.EcGateway()
resource.type = "value"
resource.create()
print(f"Created with ID: {resource.id}")

delete()

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

Example:

resource = session.ztw.EcGateway(id="your-resource-id")
resource.delete()

load()

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

Returns: EcGateway

Example:

resource = session.ztw.EcGateway(id="your-resource-id")
resource.load()
print(resource.name)

update()

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

Properties for update:

Name	Type	Required	Description
description	string	No	-
fail_closed	boolean	No	-
last_modified_by	EntityReference	No	-
last_modified_time	integer	No	-
manual_primary	string	No	-
manual_secondary	string	No	-
name	string	No	-
primary_type	string	No	-
secondary_type	string	No	-
subcloud_primary	EntityReference	No	-
subcloud_secondary	EntityReference	No	-
type	string	Yes	-

Returns: EcGateway

Example:

resource = session.ztw.EcGateway(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

Attributes

Name	Type	Required	Description
description	string	No	-
fail_closed	boolean	No	-
id	integer	No	-
last_modified_by	EntityReference	No	-
last_modified_time	integer	No	-
manual_primary	string	No	-
manual_secondary	string	No	-
name	string	No	-
primary_type	string	No	-
secondary_type	string	No	-
subcloud_primary	EntityReference	No	-
subcloud_secondary	EntityReference	No	-
type	string	Yes	-

Related

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