Dashboard

Methods described in this section relate to the dashboard API. These methods can be accessed at TenableIE.dashboard.

class DashboardAPI(api: APISession)[source]
create(name: str, order: int) → Dict[source]

Create a new dashboard instance.

Parameters:

  • name (str) – The name of the new dashboard.

  • order (int) – order of the dashboard.

Returns:

The created dashboard instance.

Return type:

dict

Examples

>>> tie.dashboard.create(
...     name='new_dashboard',
...     order=10)
delete(dashboard_id: str) → None[source]

Deletes the dashboard instance

Parameters:

dashboard_id (str) – The dashboard instance identifier.

Examples

>>> tie.dashboard.delete(dashboard_id='22')
details(dashboard_id: str) → Dict[source]

Retrieves the details for a specific dashboard instance.

Parameters:

dashboard_id (str) – The dashboard instance identifier.

Returns:

The details of the dashboard object of specified dashboard_id.

Return type:

dict

Examples

>>> tie.dashboard.details(dashboard_id='1')
list() → List[Dict][source]

Retrieve all dashboard instances.

Returns:

The list of dashboard objects.

Return type:

list

Examples

>>> tie.dashboard.list()
update(dashboard_id: str, **kwargs)[source]

Updates the dashboard instance based on dashboard_id.

Parameters:

  • dashboard_id (str) – The dashboard instance identifier.

  • name (optional, str) – The updated name.

  • order (optional, int) – The order of the dashboard.

Examples

>>> tie.dashboard.update(
...     dashboard_id='23',
...     name='updated_dashboard_name',
...     order=1)