apptotal

The following methods allow for interaction with the ZIA AppTotal API endpoints.

Methods are accessible via zia.apptotal

class AppTotalAPI

Bases: object

get_app(app_id, verbose=False)

Searches the AppTotal App Catalog by app ID. If the app exists in the catalog, the app’s information is returned. If not, the app is submitted for analysis. After analysis is complete, a subsequent GET request is required to fetch the app’s information.

Parameters:

• app_id (str) – The app ID to search for.

• verbose (bool, optional) – Defaults to False.

Returns:

The response object.

Return type:

Box

Examples

Return verbose information on an app with ID 12345:

zia.apptotal.get_app(app_id="12345", verbose=True)

scan_app(app_id)

Submits an app for analysis in the AppTotal Sandbox. After analysis is complete, a subsequent GET request is required to fetch the app’s information.

Parameters:

app_id (str) – The app ID to scan.

Returns:

The response object.

Return type:

Box

Examples

Scan an app with ID 12345:

zia.apptotal.scan_app(app_id="12345")