Dashboards API - GET all dashboards

Lists all dashboards of your Dynatrace environment, regardless of access rights in the UI.

The request produces an application/json payload.

GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/dashboards
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/dashboards

Authentication

To execute this request, you need an access token with ReadConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter
Type
Description
In
Required
owner
string

The owner of the dashboard.

query
optional
tags
string[]

A list of tags applied to the dashboard.

The dashboard must match all the specified tags.

query
optional

Response

Response codes

Code
Type
Description
200

Success

Response body objects

The DashboardList object

A list of short representations of dashboards.

Element
Type
Description
dashboards

A list of short representations of dashboards.

The DashboardStub object

A short representation of a dashboard.

Element
Type
Description
id
string

The ID of the dashboard.

name
string

The name of the dashboard.

owner
string

The owner of the dashboard.

Response body JSON model

{
  "dashboards": [
    {
      "id": "d6740373-ff26-4681-b95f-fd5b858c97f7",
      "name": "Home dashboard",
      "owner": "admin"
    },
    {
      "id": "54b34dbb-2ae7-4c27-9dbc-90a4f4c68b10",
      "name": "Databases",
      "owner": "viewer"
    },
    {
      "id": "8525b0bf-e33c-4a92-a534-9dedc1391e10",
      "name": "Business value",
      "owner": "rocks"
    }
  ]
}

Example

In this example, the request lists all dashboards of the mySampleEnv environment.

The API token is passed in the Authorization header.

The result is truncated to three entries.

Curl

curl -X GET \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/dashboards \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/config/v1/dashboards

Response body

{
  "dashboards": [
    {
      "id": "891f3203-9953-4796-aacd-886c0f59dddf",
      "name": "Home",
      "owner": "admin.user"
    },
    {
      "id": "2768e6ca-e199-4433-9e0d-2922aec2099b",
      "name": "Sample dashboard",
      "owner": "john.smith"
    },
    {
      "id": "1d7d34c6-0eb1-4131-8d29-9022f8e7f530",
      "name": "Kubernetes metrics",
      "owner": "jane.brown"
    }
  ]
}

Response code

200

Related topics