Dashboard¶
Methods described in this section relate to the dashboard API.
These methods can be accessed at TenableAD.dashboard
.
- class DashboardAPI(api: restfly.session.APISession)[source]¶
- create(name: str, order: int) → Dict[source]¶
Create a new dashboard instance.
- Parameters
- Returns
The created dashboard instance.
- Return type
Examples
>>> tad.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
>>> tad.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
Examples
>>> tad.dashboard.details(dashboard_id='1')
- list() → List[Dict][source]¶
Retrieve all dashboard instances.
- Returns
The list of dashboard objects.
- Return type
Examples
>>> tad.dashboard.list()