Skip to main content

AlertDetails

Alert Details resource for Zscaler Digital Experience.

Resource operations

This resource supports the following standard methods: load(). 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 AlertDetails
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 AlertDetails
resource = session.zdx.AlertDetails(id="your-resource-id")
resource.load()
print(resource)

# Debug output shows HTTP request/response details

Identifiers​

NameTypeDescription
idstringUnique identifier

Actions​

load()​

Gets the alert details including the impacted department, locations and geolocation as well as the alert trigger.

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

Returns: AlertDetails

Example:

resource = session.zdx.AlertDetails(id="your-resource-id")
resource.load()
print(resource.rule_name)

Attributes​

NameTypeRequiredDescription
idlongNo-
rule_namestringNo-
severitystringNo-
alert_typestringNo-
alert_statusstringNo-
applicationAlertApplicationNo-
geolocationsAlertDetailsGeolocationsCollectionNo-
departmentsAlertDetailsDepartmentsCollectionNo-
locationsAlertDetailsLocationsCollectionNo-
started_onlongNo-
ended_onlongNo-