MonitorResponse
Monitor Response resource for Zscaler Digital Experience.
This resource supports the following standard methods: load(), 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 MonitorResponse
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 MonitorResponse
resource = session.zdx.MonitorResponse(id="your-resource-id")
resource.load()
print(resource)
# Debug output shows HTTP request/response details
Identifiers
| Name | Type | Description |
|---|---|---|
id | string | Unique identifier |
Actions
activate_monitor()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
force | boolean | No | - |
Returns: StatusResponse
Example:
resource = session.zdx.MonitorResponse(id="your-resource-id")
result = resource.activate_monitor()
print(result)
deactivate_monitor()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
force | boolean | No | - |
Returns: StatusResponse
Example:
resource = session.zdx.MonitorResponse(id="your-resource-id")
result = resource.deactivate_monitor()
print(result)
delete()
Deletes a MonitorResponse by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.zdx.MonitorResponse(id="your-resource-id")
resource.delete()
get_monitor_count()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
c_id | long | No | - |
a_id | long | No | - |
Returns: MonitorCountResponse
Example:
resource = session.zdx.MonitorResponse()
result = resource.get_monitor_count()
print(result)
get_monitor_status()
Returns: StatusResponse
Example:
resource = session.zdx.MonitorResponse(id="your-resource-id")
result = resource.get_monitor_status()
print(result)
get_monitor_summary()
Returns: MonitorResponse
Example:
resource = session.zdx.MonitorResponse(id="your-resource-id")
result = resource.get_monitor_summary()
print(result)
load()
Fetches an existing MonitorResponse by id. Only the id identifier is required; load() takes no other arguments.
Returns: MonitorResponse
Example:
resource = session.zdx.MonitorResponse(id="your-resource-id")
resource.load()
print(resource.name)
set_monitor_status()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
state | string | No | - |
force | boolean | No | - |
Returns: StatusResponse
Example:
resource = session.zdx.MonitorResponse(id="your-resource-id")
result = resource.set_monitor_status()
print(result)
update_monitor()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
force | boolean | No | - |
name | string | Yes | - |
active | boolean | Yes | - |
type | string | Yes | - |
class | string | Yes | - |
deleted | boolean | No | - |
timeout_seconds | integer | Yes | - |
expires_at_timestamp | integer | Yes | - |
url | string | No | - |
excluded_departments | EntityResponseWrapperCollection | No | - |
excluded_devices | EntityResponseWrapperCollection | No | - |
excluded_geolocations | GeoLocationResponseWrapperCollection | No | - |
excluded_groups | EntityResponseWrapperCollection | No | - |
excluded_location_groups | EntityResponseWrapperCollection | No | - |
excluded_locations | EntityResponseWrapperCollection | No | - |
excluded_users | EntityResponseWrapperCollection | No | - |
on_departments | EntityResponseWrapperCollection | No | - |
on_devices | EntityResponseWrapperCollection | No | - |
on_geolocations | GeoLocationResponseWrapperCollection | No | - |
on_groups | EntityResponseWrapperCollection | No | - |
on_location_groups | EntityResponseWrapperCollection | No | - |
on_locations | EntityResponseWrapperCollection | No | - |
on_users | EntityResponseWrapperCollection | No | - |
Returns: MonitorResponse
Example:
resource = session.zdx.MonitorResponse(id="your-resource-id")
result = resource.update_monitor(name="example-name", active=True, type="value", class="value", timeout_seconds=3600, expires_at_timestamp=3600)
print(result)
Attributes
Related
- MonitorResponse - Data structure definition
- Logging guide - enable verbose logs while debugging this resource