dashboards

Creates, updates, deletes, gets or lists a dashboards resource.

Overview

Name	dashboards
Type	Resource
Id	linode.monitor.dashboards

Fields

The following fields are returned by SELECT queries:

get_dashboards_by_id

Returns a dashboard.

Name	Datatype	Description
id	integer	The unique identifier for the dashboard.
created	string (date-time)	When the dashboard was created. (example: 2024-10-10T05:01:58Z)
label	string	The name of the dashboard. This is used for display purposes in Akamai Cloud Manager. (example: Resource Usage)
service_type	string	The Akamai Cloud Computing service used by this dashboard. Currently, only the Managed Databases (dbaas) service is supported. (example: dbaas)
type	string	The type of dashboard. Currently, this can only be standard for a dashboard that uses default formatting. (example: standard)
updated	string (date-time)	When the dashboard was last updated. (example: 2024-10-12T08:15:37Z)
widgets	array	The widgets used in the dashboard.

get_dashboards

Returns a paginated list of dashboards.

Name	Datatype	Description
data	array
page	integer	Read-only The current page.
pages	integer	Read-only The total number of pages.
results	integer	Read-only The total number of results.

get_dashboards_all

Returns a paginated list of dashboards.

Name	Datatype	Description
id	integer	The unique identifier for the dashboard.
created	string (date-time)	When the dashboard was created. (example: 2024-10-10T05:01:58Z)
label	string	The name of the dashboard. This is used for display purposes in Akamai Cloud Manager. (example: Resource Usage)
service_type	string	The Akamai Cloud Computing service used by this dashboard. Currently, only the Managed Databases (dbaas) service is supported. (example: dbaas)
type	string	The type of dashboard. Currently, this can only be standard for a dashboard that uses default formatting. (example: standard)
updated	string (date-time)	When the dashboard was last updated. (example: 2024-10-12T08:15:37Z)
widgets	array	The widgets used in the dashboard.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dashboards_by_id	select			Beta Returns a specific dashboard, based on its unique ID. You can run the List dashboards operation to see the ID for all dashboards. > 📘 > > This operation is beta. Call it using the v4beta path in its URL. Learn more... Learn more...
get_dashboards	select			Beta Returns all available dashboards for a given service type. Include the appropriate service_type as a path parameter. > 📘 > > - This operation is beta. Call it using the v4beta path in its URL. > > - Currently, only the Managed Databases (dbaas) service type is supported. Learn more... Learn more...
get_dashboards_all	select			Beta Returns all available dashboards. > 📘 > > This operation is beta. Call it using the v4beta path in its URL. Learn more... Learn more...

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description

SELECT examples

get_dashboards_by_id

Beta Returns a specific dashboard, based on its unique ID. You can run the List dashboards operation to see the ID for all dashboards.

> 📘
>
> This operation is beta. Call it using the v4beta path in its URL.

Learn more...

Learn more...

SELECT
id,
created,
label,
service_type,
type,
updated,
widgets
FROM linode.monitor.dashboards;

get_dashboards

Beta Returns all available dashboards for a given service type. Include the appropriate service_type as a path parameter.

> 📘
>
> - This operation is beta. Call it using the v4beta path in its URL.
>
> - Currently, only the Managed Databases (dbaas) service type is supported.

Learn more...

Learn more...

SELECT
data,
page,
pages,
results
FROM linode.monitor.dashboards;

get_dashboards_all

Beta Returns all available dashboards.

> 📘
>
> This operation is beta. Call it using the v4beta path in its URL.

Learn more...

Learn more...

SELECT
id,
created,
label,
service_type,
type,
updated,
widgets
FROM linode.monitor.dashboards;