Skip to main content
GET
/
api
/
v1
/
config
/
dashboards
cURL
curl --request GET \
  --url https://tenant.chronosphere.io/api/v1/config/dashboards \
  --header 'API-Token: <api-key>'
{
  "dashboards": [
    {
      "name": "<string>",
      "collection": {
        "slug": "<string>",
        "type": "SIMPLE"
      },
      "collection_slug": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "dashboard_json": "<string>",
      "labels": {},
      "slug": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "page": {
    "next_token": "<string>"
  }
}

Authorizations

​
API-Token
string
header
required

Chronosphere API token

Query Parameters

​
page.max_size
integer<int64>

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.token
string

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

​
slugs
string[]

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

​
collection_slugs
string[]

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

​
names
string[]

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

​
include_dashboard_json
boolean

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

Response

A successful response.

​
dashboards
object[]
​
page
object