ApplicationResponse
Application Response resource for Digital Experience.
Resource operations
This resource supports the following standard methods: 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 ApplicationResponse
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 ApplicationResponse
resource = session.zdx.ApplicationResponse(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_application()
Activates a specific application by its ID.
Returns: Entity
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.activate_application()
print(result)
activate_application_monitor()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
aid | long | Yes | - |
force | boolean | No | - |
Returns: StatusResponse
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.activate_application_monitor(aid=3600)
print(result)
activate_predefined_application()
Activates a specific predefined application by its name.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app | string | Yes | - |
Returns: Entity
Example:
resource = session.zdx.ApplicationResponse()
result = resource.activate_predefined_application(app="value")
print(result)
activate_predefined_app_monitor()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app | string | Yes | - |
force | boolean | No | - |
Returns: StatusResponse
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.activate_predefined_app_monitor(app="value")
print(result)
create_application()
Creates a new application. The type of application determines the required fields in the request body.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
active | boolean | No | - |
collection | Entity | No | - |
description | string | No | - |
name | string | No | - |
rum_details | RUMDetails | No | - |
type | string | Yes | - |
Returns: Entity
Example:
resource = session.zdx.ApplicationResponse()
result = resource.create_application(type="value")
print(result)
deactivate_application()
Deactivates a specific application by its ID.
Returns: Entity
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.deactivate_application()
print(result)
deactivate_application_monitor()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
aid | long | Yes | - |
force | boolean | No | - |
Returns: StatusResponse
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.deactivate_application_monitor(aid=3600)
print(result)
deactivate_predefined_application()
Deactivates a specific predefined application by its name.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app | string | Yes | - |
Returns: Entity
Example:
resource = session.zdx.ApplicationResponse()
result = resource.deactivate_predefined_application(app="value")
print(result)
deactivate_predefined_app_monitor()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app | string | Yes | - |
force | boolean | No | - |
Returns: StatusResponse
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.deactivate_predefined_app_monitor(app="value")
print(result)
delete()
Deletes a custom application by its ID. Predefined applications cannot be deleted.
Deletes a ApplicationResponse by id. Only the id identifier is required; delete() takes no other arguments.
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
resource.delete()
delete_predefined_application()
Deletes a predefined application by its name. This is generally not allowed and will result in a 403 Forbidden error.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app | string | Yes | - |
force | boolean | No | - |
Example:
resource = session.zdx.ApplicationResponse()
result = resource.delete_predefined_application(app="value")
print(result)
get_application_monitor_count()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
c_id | long | No | - |
a_id | long | No | - |
Returns: MonitorCountResponse
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.get_application_monitor_count()
print(result)
get_application_monitor_status()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
aid | long | Yes | - |
Returns: StatusResponse
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.get_application_monitor_status(aid=3600)
print(result)
get_application_status()
Retrieves the current status (active or inactive) of a specific application by its ID.
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.get_application_status()
print(result)
get_predefined_application_status()
Retrieves the current status (active or inactive) of a specific predefined application by its name.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app | string | Yes | - |
Example:
resource = session.zdx.ApplicationResponse()
result = resource.get_predefined_application_status(app="value")
print(result)
get_predefined_app_monitor_count()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app | string | Yes | - |
c_id | long | No | - |
a_id | long | No | - |
Returns: MonitorCountResponse
Example:
resource = session.zdx.ApplicationResponse()
result = resource.get_predefined_app_monitor_count(app="value")
print(result)
get_predefined_app_monitor_status()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app | string | Yes | - |
Returns: StatusResponse
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.get_predefined_app_monitor_status(app="value")
print(result)
update_application()
Updates the configuration of a specific application. The request body will vary based on the application type.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
active | boolean | No | - |
collection | Entity | No | - |
description | string | No | - |
name | string | No | - |
rum_details | RUMDetails | No | - |
type | string | Yes | - |
Returns: Entity
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.update_application(type="value")
print(result)
update_application_monitor_status()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
aid | long | Yes | - |
state | string | No | - |
force | boolean | No | - |
Returns: StatusResponse
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.update_application_monitor_status(aid=3600)
print(result)
update_application_status()
Updates the status of an application to either 'active' or 'inactive'.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
status | string | Yes | - |
Returns: Entity
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.update_application_status(status="value")
print(result)
update_predefined_application()
Updates the configuration of a specific predefined application. The request body will vary based on the application type.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app | string | No | - |
active | boolean | No | - |
collection | Entity | No | - |
description | string | No | - |
name | string | No | - |
rum_details | RUMDetails | No | - |
type | string | Yes | - |
Returns: Entity
Example:
resource = session.zdx.ApplicationResponse()
result = resource.update_predefined_application(type="value")
print(result)
update_predefined_application_status()
Updates the status of a predefined application to either 'active' or 'inactive'.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app | string | Yes | - |
status | string | Yes | - |
Returns: Entity
Example:
resource = session.zdx.ApplicationResponse()
result = resource.update_predefined_application_status(app="value", status="value")
print(result)
update_predefined_app_monitor_status()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app | string | Yes | - |
state | string | No | - |
force | boolean | No | - |
Returns: StatusResponse
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.update_predefined_app_monitor_status(app="value")
print(result)
create_application_monitor()
Creates a new monitor for a specific application.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | - |
active | boolean | Yes | - |
type | string | Yes | - |
class | string | Yes | - |
deleted | boolean | No | - |
timeout_seconds | integer | Yes | - |
expires_at_timestamp | integer | Yes | - |
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.ApplicationResponse(id="your-resource-id")
result = resource.create_application_monitor(name="example-name", active=True, type="value", class="value", timeout_seconds=3600, expires_at_timestamp=3600)
print(result)
update_application_monitor()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
aid | long | No | - |
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 | - |
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.ApplicationResponse(id="your-resource-id")
result = resource.update_application_monitor(name="example-name", active=True, type="value", class="value", timeout_seconds=3600, expires_at_timestamp=3600)
print(result)
delete_application_monitor()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
aid | long | Yes | - |
Returns: MonitorResponse
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.delete_application_monitor(aid=3600)
print(result)
create_predefined_app_monitor()
Creates a new monitor for a specific application.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app | string | 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 | - |
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.ApplicationResponse()
result = resource.create_predefined_app_monitor(name="example-name", active=True, type="value", class="value", timeout_seconds=3600, expires_at_timestamp=3600)
print(result)
update_predefined_app_monitor()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app | string | No | - |
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 | - |
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.ApplicationResponse(id="your-resource-id")
result = resource.update_predefined_app_monitor(name="example-name", active=True, type="value", class="value", timeout_seconds=3600, expires_at_timestamp=3600)
print(result)
delete_predefined_app_monitor()
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
app | string | Yes | - |
Returns: MonitorResponse
Example:
resource = session.zdx.ApplicationResponse(id="your-resource-id")
result = resource.delete_predefined_app_monitor(app="value")
print(result)
Attributes
| Name | Type | Required | Description |
|---|---|---|---|
active | boolean | No | - |
collection | EntityWrapperCollection | No | - |
deleted | boolean | No | - |
description | string | No | - |
id | long | No | - |
mod_time | integer | No | - |
monitors_count | MonitorCount | No | - |
name | string | No | - |
rum_details | RUMDetails | No | - |
type | string | No | - |
Related
- ApplicationResponse - Data structure definition
- Logging guide - enable verbose logs while debugging this resource