1. Packages
  2. Grafana Cloud
  3. API Docs
  4. getDashboards
Grafana v0.16.1 published on Saturday, Mar 15, 2025 by pulumiverse

grafana.getDashboards

Explore with Pulumi AI

Grafana v0.16.1 published on Saturday, Mar 15, 2025 by pulumiverse
Deprecated: grafana.index/getdashboards.getDashboards has been deprecated in favor of grafana.oss/getdashboards.getDashboards

Datasource for retrieving all dashboards. Specify list of folder IDs to search in for dashboards.

Using getDashboards

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDashboards(args: GetDashboardsArgs, opts?: InvokeOptions): Promise<GetDashboardsResult>
function getDashboardsOutput(args: GetDashboardsOutputArgs, opts?: InvokeOptions): Output<GetDashboardsResult>
Copy
def get_dashboards(folder_uids: Optional[Sequence[str]] = None,
                   limit: Optional[int] = None,
                   org_id: Optional[str] = None,
                   tags: Optional[Sequence[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDashboardsResult
def get_dashboards_output(folder_uids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   limit: Optional[pulumi.Input[int]] = None,
                   org_id: Optional[pulumi.Input[str]] = None,
                   tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDashboardsResult]
Copy
func GetDashboards(ctx *Context, args *GetDashboardsArgs, opts ...InvokeOption) (*GetDashboardsResult, error)
func GetDashboardsOutput(ctx *Context, args *GetDashboardsOutputArgs, opts ...InvokeOption) GetDashboardsResultOutput
Copy

> Note: This function is named GetDashboards in the Go SDK.

public static class GetDashboards 
{
    public static Task<GetDashboardsResult> InvokeAsync(GetDashboardsArgs args, InvokeOptions? opts = null)
    public static Output<GetDashboardsResult> Invoke(GetDashboardsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDashboardsResult> getDashboards(GetDashboardsArgs args, InvokeOptions options)
public static Output<GetDashboardsResult> getDashboards(GetDashboardsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: grafana:index/getDashboards:getDashboards
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FolderUids List<string>
UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. ["General"] for General folder), or leave blank to get all dashboards in all folders.
Limit int
Maximum number of dashboard search results to return. Defaults to 5000.
OrgId Changes to this property will trigger replacement. string
The Organization ID. If not set, the Org ID defined in the provider block will be used.
Tags List<string>
List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.
FolderUids []string
UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. ["General"] for General folder), or leave blank to get all dashboards in all folders.
Limit int
Maximum number of dashboard search results to return. Defaults to 5000.
OrgId Changes to this property will trigger replacement. string
The Organization ID. If not set, the Org ID defined in the provider block will be used.
Tags []string
List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.
folderUids List<String>
UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. ["General"] for General folder), or leave blank to get all dashboards in all folders.
limit Integer
Maximum number of dashboard search results to return. Defaults to 5000.
orgId Changes to this property will trigger replacement. String
The Organization ID. If not set, the Org ID defined in the provider block will be used.
tags List<String>
List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.
folderUids string[]
UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. ["General"] for General folder), or leave blank to get all dashboards in all folders.
limit number
Maximum number of dashboard search results to return. Defaults to 5000.
orgId Changes to this property will trigger replacement. string
The Organization ID. If not set, the Org ID defined in the provider block will be used.
tags string[]
List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.
folder_uids Sequence[str]
UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. ["General"] for General folder), or leave blank to get all dashboards in all folders.
limit int
Maximum number of dashboard search results to return. Defaults to 5000.
org_id Changes to this property will trigger replacement. str
The Organization ID. If not set, the Org ID defined in the provider block will be used.
tags Sequence[str]
List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.
folderUids List<String>
UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. ["General"] for General folder), or leave blank to get all dashboards in all folders.
limit Number
Maximum number of dashboard search results to return. Defaults to 5000.
orgId Changes to this property will trigger replacement. String
The Organization ID. If not set, the Org ID defined in the provider block will be used.
tags List<String>
List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.

getDashboards Result

The following output properties are available:

Dashboards List<Pulumiverse.Grafana.Outputs.GetDashboardsDashboard>
Id string
The provider-assigned unique ID for this managed resource.
FolderUids List<string>
UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. ["General"] for General folder), or leave blank to get all dashboards in all folders.
Limit int
Maximum number of dashboard search results to return. Defaults to 5000.
OrgId string
The Organization ID. If not set, the Org ID defined in the provider block will be used.
Tags List<string>
List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.
Dashboards []GetDashboardsDashboard
Id string
The provider-assigned unique ID for this managed resource.
FolderUids []string
UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. ["General"] for General folder), or leave blank to get all dashboards in all folders.
Limit int
Maximum number of dashboard search results to return. Defaults to 5000.
OrgId string
The Organization ID. If not set, the Org ID defined in the provider block will be used.
Tags []string
List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.
dashboards List<GetDashboardsDashboard>
id String
The provider-assigned unique ID for this managed resource.
folderUids List<String>
UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. ["General"] for General folder), or leave blank to get all dashboards in all folders.
limit Integer
Maximum number of dashboard search results to return. Defaults to 5000.
orgId String
The Organization ID. If not set, the Org ID defined in the provider block will be used.
tags List<String>
List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.
dashboards GetDashboardsDashboard[]
id string
The provider-assigned unique ID for this managed resource.
folderUids string[]
UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. ["General"] for General folder), or leave blank to get all dashboards in all folders.
limit number
Maximum number of dashboard search results to return. Defaults to 5000.
orgId string
The Organization ID. If not set, the Org ID defined in the provider block will be used.
tags string[]
List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.
dashboards Sequence[GetDashboardsDashboard]
id str
The provider-assigned unique ID for this managed resource.
folder_uids Sequence[str]
UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. ["General"] for General folder), or leave blank to get all dashboards in all folders.
limit int
Maximum number of dashboard search results to return. Defaults to 5000.
org_id str
The Organization ID. If not set, the Org ID defined in the provider block will be used.
tags Sequence[str]
List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.
dashboards List<Property Map>
id String
The provider-assigned unique ID for this managed resource.
folderUids List<String>
UIDs of Grafana folders containing dashboards. Specify to filter for dashboards by folder (eg. ["General"] for General folder), or leave blank to get all dashboards in all folders.
limit Number
Maximum number of dashboard search results to return. Defaults to 5000.
orgId String
The Organization ID. If not set, the Org ID defined in the provider block will be used.
tags List<String>
List of string Grafana dashboard tags to search for, eg. ["prod"]. Used only as search input, i.e., attribute value will remain unchanged.

Supporting Types

GetDashboardsDashboard

FolderTitle This property is required. string
Title This property is required. string
Uid This property is required. string
FolderTitle This property is required. string
Title This property is required. string
Uid This property is required. string
folderTitle This property is required. String
title This property is required. String
uid This property is required. String
folderTitle This property is required. string
title This property is required. string
uid This property is required. string
folder_title This property is required. str
title This property is required. str
uid This property is required. str
folderTitle This property is required. String
title This property is required. String
uid This property is required. String

Package Details

Repository
grafana pulumiverse/pulumi-grafana
License
Apache-2.0
Notes
This Pulumi package is based on the grafana Terraform Provider.
Grafana v0.16.1 published on Saturday, Mar 15, 2025 by pulumiverse