v1

latestOpenAPI 3.0.32026-07-26191565482.4 KB
GrafanaDashboard

get/api/v1/config/grafana-dashboards

Query parameters

page.max_sizeinteger

Sets the preferred number of items to return per page. If set to 0, the server will use its default value. Regardless of the value specified, clients must never assume how many items will be returned.

page.tokenstring

An opaque page token that identifies which page the client should request. An empty value indicates the first page.

slugsstring[]

Filters results by slug, where any GrafanaDashboard with a matching slug in the given list (and matches all other filters) will be returned.

bucket_slugsstring[]

Filters results by bucket_slug, where any GrafanaDashboard with a matching bucket_slug in the given list (and matches all other filters) will be returned.

collection_slugsstring[]

Filters results by collection_slug, where any GrafanaDashboard with a matching collection_slug in the given list (and matches all other filters) will be returned.

namesstring[]

Filters results by name, where any GrafanaDashboard with a matching name in the given list (and matches all other filters) will be returned.

include_dashboard_jsonboolean

Optional flag to populate the dashboard_json of the returned dashboards. By default, dashboard_json will be left empty.

Response

A successful response.