apptotal¶

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

Methods are accessible via zia.apptotal

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class AppTotalAPI¶

Bases: APIClient

A Client object for the predefined and custom Cloud Applications resource.

app_views(app_view_id)¶

Searches for an app by name. Any app whose name contains the search term (app_name) is returned. Note: The maximum number of results that are returned is 200.

Parameters:: app_name (str) – The app name to search for.
Returns:: A tuple containing the AppTotalSearch object and the response object.
Return type:: tuple

Examples

Search for an app by name “Slack”:

zia.apptotal.search_app(app_name="Slack")

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:

A tuple containing the AppTotal object and the response object.

Return type:

tuple

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:: tuple

Examples

Scan an app with ID 12345:

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

search_app(app_name)¶

Searches for an app by name. Any app whose name contains the search term (app_name) is returned. Note: The maximum number of results that are returned is 200.

Parameters:: app_name (str) – The app name to search for.
Returns:: A tuple containing the AppTotalSearch object and the response object.
Return type:: tuple

Examples

Search for an app by name “Slack”:

zia.apptotal.search_app(app_name="Slack")