ApiKey

Api Key resource for Zscaler Cloud & Branch Connector.

Resource operations

This resource does not support standard CRUDL methods. Each 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 ApiKey
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",
)

# Call regenerate_api_key on ApiKey
resource = session.ztw.ApiKey()
result = resource.regenerate_api_key(id=3600)
print(result)

# Debug output shows HTTP request/response details

Actions

regenerate_api_key()

Returns: ApiKey

Example:

resource = session.ztw.ApiKey()
result = resource.regenerate_api_key(id=3600)
print(result)

Attributes

Name	Type	Required	Description
enabled	boolean	No	-
id	integer	Yes	-
key_value	string	No	-
last_modified_by	EntityReference	No	-
last_modified_time	integer	No	-
name	string	Yes	-
partner	EntityReference	No	-
partner_url	string	No	-
permissions	PermissionsEnumCollection	No	-
smsm_keyid	integer	No	-

Related

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