Collection

Collection resource for Zscaler Digital Experience.

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

Properties for creation:

Name	Type	Required	Description
active	boolean	No	-
description	string	No	-
filters	ZDXCollectionFilter	No	-
name	string	Yes	-
tags	ZDXCollectionTagWrapperCollection	No	-
type	string	Yes	-

Returns: Collection

Example:

resource = session.zdx.Collection()
resource.name = "example-name"
resource.type = "value"
resource.create()
print(f"Created with ID: {resource.id}")

delete()

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

Example:

resource = session.zdx.Collection(id="your-resource-id")
resource.delete()

import_collection_applications()

Parameters:

Name	Type	Required	Description
r	EntityCollection	Yes	-

Returns: Entity

Example:

resource = session.zdx.Collection(id="your-resource-id")
result = resource.import_collection_applications(r=[{"deleted": True, "id": 3600, "name": "example-name"}])
print(result)

load()

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

Returns: Collection

Example:

resource = session.zdx.Collection(id="your-resource-id")
resource.load()
print(resource.name)

remove_collection_app()

Parameters:

Name	Type	Required	Description
app_id	long	Yes	-

Returns: Collection

Example:

resource = session.zdx.Collection(id="your-resource-id")
result = resource.remove_collection_app(app_id=3600)
print(result)

update()

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

Properties for update:

Name	Type	Required	Description
active	boolean	No	-
description	string	No	-
filters	ZDXCollectionFilter	No	-
name	string	Yes	-
tags	ZDXCollectionTagWrapperCollection	No	-
type	string	Yes	-

Returns: Collection

Example:

resource = session.zdx.Collection(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

update_collection_rank()

Parameters:

Name	Type	Required	Description
rank_id	integer	Yes	-

Returns: StringRecord

Example:

resource = session.zdx.Collection(id="your-resource-id")
result = resource.update_collection_rank(rank_id=3600)
print(result)

update_collection_status()

Parameters:

Name	Type	Required	Description
status	string	Yes	-

Returns: Collection

Example:

resource = session.zdx.Collection(id="your-resource-id")
result = resource.update_collection_status(status="value")
print(result)

Attributes

Name	Type	Required	Description
id	long	Yes	-
rank	integer	Yes	-
default	boolean	Yes	-
apps	UnifiedApplicationForCollectionWrapperCollection	Yes	-
mod_time	integer	Yes	-
mod_uid	integer	Yes	-
active	boolean	No	-
description	string	No	-
filters	ZDXCollectionFilter	No	-
name	string	Yes	-
tags	ZDXCollectionTagWrapperCollection	No	-
type	string	Yes	-

Related

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