Skip to main content

InspectionProfile

Inspection Profile resource for Zscaler Private Access V1.

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 InspectionProfile
logging.getLogger('zssdk.zpa').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 InspectionProfile
resource = session.zpa.InspectionProfile(id="your-resource-id")
resource.load()
print(resource)

# Debug output shows HTTP request/response details

Identifiers​

NameTypeDescription
idstringUnique identifier

Actions​

associate_all_predefined_controls()​

Parameters:

NameTypeRequiredDescription
customer_idlongYes-
versionstringYes-

Example:

resource = session.zpa.InspectionProfile(id="your-resource-id")
result = resource.associate_all_predefined_controls(customer_id=3600, version="value")
print(result)

create()​

Creates a new InspectionProfile. Set properties on the resource instance, then call create() — this method takes no arguments.

Properties for creation:

NameTypeRequiredDescription
customer_idlongNo-
idlongNo-
modified_timeintegerNo-
creation_timeintegerNo-
modified_bylongNo-
namestringYes-
descriptionstringNo-
paranoia_levelintegerYes-
global_control_actionsstringCollectionNo-
zs_defined_control_choicestringNo-
predefined_controls_versionstringNo-
predefined_controlsInspectionPredefinedControlWrapperCollectionNo-
predefined_api_controlsInspectionPredefinedControlWrapperCollectionNo-
custom_controlsInspectionCustomControlWrapperCollectionNo-
threatlabz_controlsInspectionZSDefinedControlWrapperCollectionNo-
websocket_controlsInspectionControlBaseEntityWrapperCollectionNo-
controls_infoInspectionProfileControlsInfoResourceWrapperCollectionNo-
incarnation_numberintegerNo-
check_control_deployment_statusbooleanNo-
predefined_ADP_controlsInspectionPredefinedControlWrapperCollectionNo-
exceptions_versionintegerNo-
api_profilebooleanNo-
api_discovery_enabledbooleanNo-
name_without_trimstringNo-
has_recommended_owasp_controlsbooleanNo-
has_recommended_threatlabz_controlsbooleanNo-

Example:

resource = session.zpa.InspectionProfile()
resource.name = "example-name"
resource.paranoia_level = 3600
resource.create()
print(f"Created with ID: {resource.id}")

de_associate_all_predefined_controls()​

Parameters:

NameTypeRequiredDescription
customer_idlongYes-

Example:

resource = session.zpa.InspectionProfile(id="your-resource-id")
result = resource.de_associate_all_predefined_controls(customer_id=3600)
print(result)

delete()​

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

Example:

resource = session.zpa.InspectionProfile(id="your-resource-id")
resource.delete()

dissociate_all_predefined_controls()​

Parameters:

NameTypeRequiredDescription
customer_idlongYes-

Example:

resource = session.zpa.InspectionProfile(id="your-resource-id")
result = resource.dissociate_all_predefined_controls(customer_id=3600)
print(result)

load()​

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

Returns: InspectionProfile

Example:

resource = session.zpa.InspectionProfile(id="your-resource-id")
resource.load()
print(resource.name)

update()​

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

Properties for update:

NameTypeRequiredDescription
customer_idlongNo-
idlongNo-
modified_timeintegerNo-
creation_timeintegerNo-
modified_bylongNo-
namestringYes-
descriptionstringNo-
paranoia_levelintegerYes-
global_control_actionsstringCollectionNo-
zs_defined_control_choicestringNo-
predefined_controls_versionstringNo-
predefined_controlsInspectionPredefinedControlWrapperCollectionNo-
predefined_api_controlsInspectionPredefinedControlWrapperCollectionNo-
custom_controlsInspectionCustomControlWrapperCollectionNo-
threatlabz_controlsInspectionZSDefinedControlWrapperCollectionNo-
websocket_controlsInspectionControlBaseEntityWrapperCollectionNo-
controls_infoInspectionProfileControlsInfoResourceWrapperCollectionNo-
incarnation_numberintegerNo-
check_control_deployment_statusbooleanNo-
predefined_ADP_controlsInspectionPredefinedControlWrapperCollectionNo-
exceptions_versionintegerNo-
api_profilebooleanNo-
api_discovery_enabledbooleanNo-
name_without_trimstringNo-
has_recommended_owasp_controlsbooleanNo-
has_recommended_threatlabz_controlsbooleanNo-

Example:

resource = session.zpa.InspectionProfile(id="your-resource-id")
resource.load()
resource.name = "Updated value"
resource.update()

Attributes​

NameTypeRequiredDescription
idlongNo-
modified_timeintegerNo-
creation_timeintegerNo-
modified_bylongNo-
namestringYes-
descriptionstringNo-
paranoia_levelintegerYes-
global_control_actionsstringCollectionNo-
zs_defined_control_choicestringNo-
predefined_controls_versionstringNo-
predefined_controlsInspectionPredefinedControlWrapperCollectionNo-
predefined_api_controlsInspectionPredefinedControlWrapperCollectionNo-
custom_controlsInspectionCustomControlWrapperCollectionNo-
threatlabz_controlsInspectionZSDefinedControlWrapperCollectionNo-
websocket_controlsInspectionControlBaseEntityWrapperCollectionNo-
controls_infoInspectionProfileControlsInfoResourceWrapperCollectionNo-
incarnation_numberintegerNo-
check_control_deployment_statusbooleanNo-
predefined_ADP_controlsInspectionPredefinedControlWrapperCollectionNo-
exceptions_versionintegerNo-
api_profilebooleanNo-
api_discovery_enabledbooleanNo-
name_without_trimstringNo-
has_recommended_owasp_controlsbooleanNo-
has_recommended_threatlabz_controlsbooleanNo-