Dashboards API - PUT a dashboard

Updates the specified dashboard.

The request consumes and produces an application/json payload.

PUT	Managed	`https://{your-domain}/e/{your-environment-id}/api/config/v1/dashboards/{id}`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/dashboards/{id}`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/dashboards/{id}`

Authentication

To execute this request, you need an access token with Write configuration (WriteConfig) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Refer to Tile JSON models to find JSON models for each tile type.

Parameter	Type	Description	In	Required
id	string	The ID of the dashboard to be updated. The ID in the request body must match this ID.	path	required
body	Dashboard	The JSON body of the request. Contains updated parameters of the dashboard.	body	optional

Parameter

Type

Description

Required

string

The ID of the dashboard to be updated.

The ID in the request body must match this ID.

path

required

body

Dashboard

The JSON body of the request. Contains updated parameters of the dashboard.

body

optional

Request body objects

The `Dashboard` object

Configuration of a dashboard.

Element	Type	Description	Required
metadata	ConfigurationMetadata	Metadata useful for debugging	optional
id	string	The ID of the dashboard.	optional
dashboardMetadata	DashboardMetadata	Parameters of a dashboard.	required
tiles	Tile[]	The list of tiles on the dashboard.	required

The `ConfigurationMetadata` object

Metadata useful for debugging

Element	Type	Description	Required
currentConfigurationVersions	string[]	A sorted list of version numbers of the configuration.	optional
clusterVersion	string	Dynatrace version.	optional
configurationVersions	integer[]	A sorted list of the version numbers of the configuration.	optional

The `DashboardMetadata` object

Parameters of a dashboard.

Element	Type	Description	Required
name	string	The name of the dashboard.	required
shared	boolean	The dashboard is shared (`true`) or private (`false`).	optional
owner	string	The owner of the dashboard.	required
dashboardFilter	DashboardFilter	Filters, applied to a dashboard.	optional
tags	string[]	A set of tags assigned to the dashboard.	optional
preset	boolean	The dashboard is a preset (`true`) or a custom (`false`) dashboard.	optional
dynamicFilters	DynamicFilters	Dashboard filter configuration of a dashboard.	optional
tilesNameSize	string	The general size of the tiles tile. Default value is medium The element can hold these values `small` `medium` `large`	optional
hasConsistentColors	boolean	The tile uses consistent colors when rendering its content.	optional

The `DashboardFilter` object

Filters, applied to a dashboard.

Element	Type	Description	Required
timeframe	string	The default timeframe of the dashboard.	optional
managementZone	EntityShortRepresentation	The short representation of a Dynatrace entity.	optional

The `EntityShortRepresentation` object

The short representation of a Dynatrace entity.

Element	Type	Description	Required
id	string	The ID of the Dynatrace entity.	required
name	string	The name of the Dynatrace entity.	optional
description	string	A short description of the Dynatrace entity.	optional

The `DynamicFilters` object

Dashboard filter configuration of a dashboard.

Element Type Description Required

filters

string[]

Element	Type	Description	Required
filters	string[]	A set of all possible global dashboard filters that can be applied to a dashboard Currently supported values are: `OS_TYPE, SERVICE_TYPE, DEPLOYMENT_TYPE, APPLICATION_INJECTION_TYPE, PAAS_VENDOR_TYPE, DATABASE_VENDOR, HOST_VIRTUALIZATION_TYPE, HOST_MONITORING_MODE, KUBERNETES_CLUSTER, RELATED_CLOUD_APPLICATION, RELATED_NAMESPACE, SERVICE_TAG_KEY:<tagname>, HOST_TAG_KEY:<tagname>, APPLICATION_TAG_KEY:<tagname>, CUSTOM_DIMENSION:<key>, PROCESS_GROUP_TAG_KEY:<tagname>, PROCESS_GROUP_INSTANCE_TAG_KEY:<tagname>`	required
tagSuggestionTypes	string[]	A set of entities applied for tag filter suggestions. You can fetch the list of possible values with the GET all entity typesrequest. Only applicable if the filters set includes `TAG_KEY:<tagname>`.	optional

A set of all possible global dashboard filters that can be applied to a dashboard

Currently supported values are:

OS_TYPE,
SERVICE_TYPE,
DEPLOYMENT_TYPE,
APPLICATION_INJECTION_TYPE,
PAAS_VENDOR_TYPE,
DATABASE_VENDOR,
HOST_VIRTUALIZATION_TYPE,
HOST_MONITORING_MODE,
KUBERNETES_CLUSTER,
RELATED_CLOUD_APPLICATION,
RELATED_NAMESPACE,
SERVICE_TAG_KEY:<tagname>,
HOST_TAG_KEY:<tagname>,
APPLICATION_TAG_KEY:<tagname>,
CUSTOM_DIMENSION:<key>,
PROCESS_GROUP_TAG_KEY:<tagname>,
PROCESS_GROUP_INSTANCE_TAG_KEY:<tagname>

required

tagSuggestionTypes

string[]

A set of entities applied for tag filter suggestions. You can fetch the list of possible values with the GET all entity typesrequest.

Only applicable if the filters set includes TAG_KEY:<tagname>.

optional

The `Tile` object

Configuration of a tile.

The actual set of fields depends on the type of the tile. Find the list of actual objects in the description of the tileType field or see Dashboards API - Tile JSON models.

Element	Type	Description	Required
name	string	The name of the tile.	required
nameSize	string	The size of the tile name. Default value is null. The element can hold these values `small` `medium` `large`	optional
tileType	string	Defines the actual set of fields depending on the value. See one of the following objects: `DATA_EXPLORER` -> DataExplorerTile `CUSTOM_CHARTING` -> CustomChartingTile `DTAQL` -> UserSessionQueryTile `MARKDOWN` -> MarkdownTile `IMAGE` -> ImageTile `HOSTS` -> FilterableEntityTile `APPLICATIONS` -> FilterableEntityTile `SERVICES` -> FilterableEntityTile `DATABASES_OVERVIEW` -> FilterableEntityTile `SYNTHETIC_TESTS` -> FilterableEntityTile `APPLICATION_WORLDMAP` -> AssignedEntitiesWithMetricTile `RESOURCES` -> AssignedEntitiesWithMetricTile `THIRD_PARTY_MOST_ACTIVE` -> AssignedEntitiesWithMetricTile `UEM_CONVERSIONS_PER_GOAL` -> AssignedEntitiesWithMetricTile `HOST` -> AssignedEntitiesWithMetricTile `PROCESS_GROUPS_ONE` -> AssignedEntitiesWithMetricTile `SYNTHETIC_SINGLE_WEBCHECK` -> SyntheticSingleWebcheckTile `APPLICATION` -> AssignedEntitiesTile `VIRTUALIZATION` -> AssignedEntitiesTile `AWS` -> AssignedEntitiesTile `SERVICE_VERSATILE` -> AssignedEntitiesTile `SESSION_METRICS` -> AssignedEntitiesTile `USERS` -> AssignedEntitiesTile `UEM_KEY_USER_ACTIONS` -> AssignedEntitiesTile `BOUNCE_RATE` -> AssignedEntitiesTile `UEM_CONVERSIONS_OVERALL` -> AssignedEntitiesTile `UEM_JSERRORS_OVERALL` -> AssignedEntitiesTile `MOBILE_APPLICATION` -> AssignedEntitiesTile `SYNTHETIC_SINGLE_EXT_TEST` -> AssignedEntitiesTile `SYNTHETIC_HTTP_MONITOR` -> AssignedEntitiesTile `DATABASE` -> AssignedEntitiesTile `CUSTOM_APPLICATION` -> AssignedEntitiesTile `APPLICATION_METHOD` -> AssignedEntitiesTile `LOG_ANALYTICS` -> AssignedEntitiesTile `OPENSTACK` -> AssignedEntitiesTile `OPENSTACK_PROJECT` -> AssignedEntitiesTile `OPENSTACK_AV_ZONE` -> AssignedEntitiesTile `DEVICE_APPLICATION_METHOD` -> AssignedEntitiesTile `DEM_KEY_USER_ACTION` -> AssignedEntitiesTile `SLO` -> AssignedEntitiesWithMetricTile `SCALABLE_LIST` -> ScalableListTile `HEADER` -> Tile `OPEN_PROBLEMS` -> ProblemTile `PURE_MODEL` -> Tile `DOCKER` -> Tile `NETWORK_MEDIUM` -> Tile `APPLICATIONS_MOST_ACTIVE` -> Tile `NETWORK` -> Tile `UEM_ACTIVE_SESSIONS` -> Tile `DCRUM_SERVICES` -> Tile The element can hold these values `APPLICATION` `APPLICATIONS` `APPLICATIONS_MOST_ACTIVE` `APPLICATION_METHOD` `APPLICATION_WORLDMAP` `AWS` `BOUNCE_RATE` `CUSTOM_APPLICATION` `CUSTOM_CHARTING` `DATABASE` `DATABASES_OVERVIEW` `DATA_EXPLORER` `DCRUM_SERVICES` `DEM_KEY_USER_ACTION` `DEVICE_APPLICATION_METHOD` `DOCKER` `DTAQL` `HEADER` `HOST` `HOSTS` `IMAGE` `LOG_ANALYTICS` `MARKDOWN` `MOBILE_APPLICATION` `NETWORK` `NETWORK_MEDIUM` `OPENSTACK` `OPENSTACK_AV_ZONE` `OPENSTACK_PROJECT` `OPEN_PROBLEMS` `PROCESS_GROUPS_ONE` `PURE_MODEL` `RESOURCES` `SCALABLE_LIST` `SERVICES` `SERVICE_VERSATILE` `SESSION_METRICS` `SLO` `SYNTHETIC_HTTP_MONITOR` `SYNTHETIC_SINGLE_EXT_TEST` `SYNTHETIC_SINGLE_WEBCHECK` `SYNTHETIC_TESTS` `THIRD_PARTY_MOST_ACTIVE` `UEM_ACTIVE_SESSIONS` `UEM_CONVERSIONS_OVERALL` `UEM_CONVERSIONS_PER_GOAL` `UEM_JSERRORS_OVERALL` `UEM_KEY_USER_ACTIONS` `USERS` `VIRTUALIZATION`	required
configured	boolean	The tile is configured and ready to use (`true`) or just placed on the dashboard (`false`).	optional
bounds	TileBounds	The position and size of a tile.	required
tileFilter	TileFilter	A filter applied to a tile. It overrides dashboard's filter.	optional

The `TileBounds` object

The position and size of a tile.

Element	Type	Description	Required
top	integer	The vertical distance from the top left corner of the dashboard to the top left corner of the tile, in pixels.	optional
left	integer	The horizontal distance from the top left corner of the dashboard to the top left corner of the tile, in pixels.	optional
width	integer	The width of the tile, in pixels.	optional
height	integer	The height of the tile, in pixels.	optional

The `TileFilter` object

A filter applied to a tile.

It overrides dashboard's filter.

Element	Type	Description	Required
timeframe	string	The default timeframe of the tile.	optional
managementZone	EntityShortRepresentation	The short representation of a Dynatrace entity.	optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

json
{
  "metadata": {
    "configurationVersions": [
      4,
      2
    ],
    "clusterVersion": "Mock version"
  },
  "dashboardMetadata": {
    "name": "Example Dashboard",
    "owner": "Example Owner",
    "shared": true,
    "dashboardFilter": {
      "timeframe": "l_72_HOURS",
      "managementZone": {
        "id": "3438779970106539862",
        "name": "Example Management Zone"
      }
    },
    "dynamicFilters": {
      "filters": [
        "SERVICE_TYPE"
      ],
      "tagSuggestionTypes": [
        "HOST_LIKE"
      ]
    }
  },
  "tiles": [
    {
      "name": "Hosts",
      "tileType": "HEADER",
      "configured": true,
      "bounds": {
        "top": 0,
        "left": 0,
        "width": 304,
        "height": 38
      },
      "tileFilter": {}
    },
    {
      "name": "Applications",
      "tileType": "HEADER",
      "configured": true,
      "bounds": {
        "top": 0,
        "left": 304,
        "width": 304,
        "height": 38
      },
      "tileFilter": {}
    },
    {
      "name": "Host health",
      "tileType": "HOSTS",
      "configured": true,
      "bounds": {
        "top": 38,
        "left": 0,
        "width": 304,
        "height": 304
      },
      "tileFilter": {
        "managementZone": {
          "id": "3438779970106539862",
          "name": "Example Management Zone"
        }
      },
      "chartVisible": true
    },
    {
      "name": "Application health",
      "tileType": "APPLICATIONS",
      "configured": true,
      "bounds": {
        "top": 38,
        "left": 304,
        "width": 304,
        "height": 304
      },
      "tileFilter": {
        "managementZone": {
          "id": "3438779970106539862",
          "name": "Example Management Zone"
        }
      },
      "chartVisible": true
    }
  ]
}

Response

Response codes

Code	Type	Description
201	EntityShortRepresentation	Success. The new dashboard has been created. Response doesn't have a body.
204		Success. The dashboard has been updated. Response doesn't have a body
400	ErrorEnvelope	Failed. The input is invalid

Response body objects

The `EntityShortRepresentation` object

The short representation of a Dynatrace entity.

Element	Type	Description
id	string	The ID of the Dynatrace entity.
name	string	The name of the Dynatrace entity.
description	string	A short description of the Dynatrace entity.

Response body JSON model

json
{
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity",
  "description": "Dynatrace entity for the REST API example"
}

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

POST	Managed	`https://{your-domain}/e/{your-environment-id}/api/config/v1/dashboards/{id}/validator`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/dashboards/{id}/validator`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/dashboards/{id}/validator`

Authentication

To execute this request, you need an access token with Write configuration (WriteConfig) scope. To learn how to obtain and use it, see Tokens and authentication.

Response

POST	Managed	`https://{your-domain}/e/{your-environment-id}/api/config/v1/dashboards/validator`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/dashboards/validator`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/dashboards/validator`

Authentication

To execute this request, you need an access token with Write configuration (WriteConfig) scope. To learn how to obtain and use it, see Tokens and authentication.

Example

In this example, the request adds the Service health tile to the Sample dashboard in the GET request example.

The tile shows the health of all services belonging to the Easytravel management zone. It is located next to the existing Host health tile and has the same size (304x304 pixels).

The API token is passed in the Authorization header.

Since the request body is lengthy, it is truncated in this example Curl section. See the full body in the Request body section. You can download or copy the example request body to try it out on your own. Be sure to change the ID and name of the Easytravel management zone to a management zone that exists in your environment or set this field to null.

Curl

bash
curl -X PUT \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/dashboards/2768e6ca-e199-4433-9e0d-2922aec2099b \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{<truncated - see the Request body section >}'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/config/v1/dashboards/2768e6ca-e199-4433-9e0d-2922aec2099b

Request body

json
{
  "id": "2768e6ca-e199-4433-9e0d-2922aec2099b",
  "dashboardMetadata": {
    "name": "Sample dashboard",
    "shared": true,
    "owner": "john.smith",
    "sharingDetails": {
      "linkShared": true,
      "published": true
    },
    "dashboardFilter": {
      "timeframe": "l_2_HOURS",
      "managementZone": null
    }
  },
  "tiles": [
    {
      "name": "Host health",
      "tileType": "HOSTS",
      "configured": true,
      "bounds": {
        "top": 0,
        "left": 304,
        "width": 304,
        "height": 304
      },
      "tileFilter": {
        "managementZone": {
          "id": "9130632296508575249",
          "name": "Easytravel"
        }
      },
      "filterConfig": null,
      "chartVisible": true
    },
    {
      "name": "User behavior",
      "tileType": "SESSION_METRICS",
      "configured": true,
      "bounds": {
        "top": 0,
        "left": 0,
        "width": 304,
        "height": 304
      },
      "tileFilter": {
        "managementZone": null
      },
      "assignedEntities": ["APPLICATION-8E41C8C247910758"]
    },
    {
      "name": "Service health",
      "tileType": "SERVICES",
      "configured": true,
      "bounds": {
        "top": 0,
        "left": 608,
        "width": 304,
        "height": 304
      },
      "tileFilter": {
        "managementZone": {
          "id": "9130632296508575249",
          "name": "Easytravel"
        }
      },
      "filterConfig": null,
      "chartVisible": true
    }
  ]
}

Response code

204

Dashboards API - PUT a dashboard

Authentication

Parameters

Request body objects

The Dashboard object

The ConfigurationMetadata object

The DashboardMetadata object

The DashboardFilter object

The EntityShortRepresentation object

The DynamicFilters object

The Tile object

The TileBounds object

The TileFilter object

Request body JSON model

Response

Response codes

Response body objects

The EntityShortRepresentation object

Response body JSON model

Validate payload

Authentication

Response

Authentication

Example

Curl

Request URL

Request body

Response code

Result

The `Dashboard` object

The `ConfigurationMetadata` object

The `DashboardMetadata` object

The `DashboardFilter` object

The `EntityShortRepresentation` object

The `DynamicFilters` object

The `Tile` object

The `TileBounds` object

The `TileFilter` object

The `EntityShortRepresentation` object