v1

latestOpenAPI 3.0.12026-07-13149396412.1 KB
Dashboard

get/api/v1/config/dashboards

Query parameters

page.max_sizeinteger

Page size preference (i.e. how many items are returned in the next page). If zero, the server will use a default. Regardless of what size is given, clients must never assume how many items will be returned.

page.tokenstring

Opaque page token identifying which page to request. An empty token identifies the first page.

slugsstring[]

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

collection_slugsstring[]

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

namesstring[]

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

include_dashboard_jsonboolean

Optional. Flag to populate the dashboard_json field of the returned dashboards. By default, dashboard_json is empty.

Response

A successful response.