Dashboards API - PUT a dashboard
Updates the specified dashboard.
The request consumes and produces an application/json
payload.
PUT | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/dashboards/{id} |
Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/dashboards/{id} |
Authentication
To execute this request, you need an access token with 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.
The ID of the dashboard to be updated.
The ID in the request body must match this ID.
The JSON body of the request. Contains updated parameters of the dashboard.
Request body objects
The Dashboard
object
Configuration of a dashboard.
The ID of the dashboard.
The DashboardMetadata
object
Parameters of a dashboard.
The tile uses consistent colors when rendering its content.
The name of the dashboard.
The owner of the dashboard.
The dashboard is a preset (true
) or a custom (false
) dashboard.
The dashboard is shared (true
) or private (false
).
A set of tags assigned to the dashboard.
The general size of the tiles tile. Default value is medium
small
medium
large
The DashboardFilter
object
Filters, applied to a dashboard.
The default timeframe of the dashboard.
The EntityShortRepresentation
object
The short representation of a Dynatrace entity.
A short description of the Dynatrace entity.
The ID of the Dynatrace entity.
The name of the Dynatrace entity.
The DynamicFilters
object
Dashboard filter configuration of a dashboard.
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>
A set of generic tag filters that can be applied to a dashboard
The DashboardGenericTagFilter
object
Generic tag filters that can be applied to a dashboard.
The display name used to identify this generic filter.
Entity types affected by tag.
The entity type for which the suggestions should be provided.
The tag key for this filter.
The ConfigurationMetadata
object
Metadata useful for debugging
Dynatrace version.
A sorted list of the version numbers of the configuration.
A sorted list of version numbers of the configuration.
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.
The tile is configured and ready to use (true
) or just placed on the dashboard (false
).
The tile auto refresh is disabled. Only works for certain tile types.
The name of the tile.
The size of the tile name. Default value is null.
small
medium
large
Defines the actual set of fields depending on the value. See one of the following objects:
DATA_EXPLORER
-> DataExplorerTileCUSTOM_CHARTING
-> CustomChartingTileDTAQL
-> UserSessionQueryTileMARKDOWN
-> MarkdownTileIMAGE
-> ImageTileHOSTS
-> FilterableEntityTileAPPLICATIONS
-> FilterableEntityTileSERVICES
-> FilterableEntityTileDATABASES_OVERVIEW
-> FilterableEntityTileSYNTHETIC_TESTS
-> FilterableEntityTileAPPLICATION_WORLDMAP
-> AssignedEntitiesWithMetricTileRESOURCES
-> AssignedEntitiesWithMetricTileTHIRD_PARTY_MOST_ACTIVE
-> AssignedEntitiesWithMetricTileUEM_CONVERSIONS_PER_GOAL
-> AssignedEntitiesWithMetricTileHOST
-> AssignedEntitiesWithMetricTilePROCESS_GROUPS_ONE
-> AssignedEntitiesWithMetricTileSYNTHETIC_SINGLE_WEBCHECK
-> SyntheticSingleWebcheckTileAPPLICATION
-> AssignedEntitiesTileVIRTUALIZATION
-> AssignedEntitiesTileAWS
-> AssignedEntitiesTileSERVICE_VERSATILE
-> AssignedEntitiesTileSESSION_METRICS
-> AssignedEntitiesTileUSERS
-> AssignedEntitiesTileUEM_KEY_USER_ACTIONS
-> AssignedEntitiesTileBOUNCE_RATE
-> AssignedEntitiesTileUEM_CONVERSIONS_OVERALL
-> AssignedEntitiesTileUEM_JSERRORS_OVERALL
-> AssignedEntitiesTileMOBILE_APPLICATION
-> AssignedEntitiesTileSYNTHETIC_SINGLE_EXT_TEST
-> AssignedEntitiesTileSYNTHETIC_HTTP_MONITOR
-> AssignedEntitiesTileDATABASE
-> AssignedEntitiesTileCUSTOM_APPLICATION
-> AssignedEntitiesTileAPPLICATION_METHOD
-> AssignedEntitiesTileLOG_ANALYTICS
-> AssignedEntitiesTileOPENSTACK
-> AssignedEntitiesTileOPENSTACK_PROJECT
-> AssignedEntitiesTileOPENSTACK_AV_ZONE
-> AssignedEntitiesTileDEVICE_APPLICATION_METHOD
-> AssignedEntitiesTileDEM_KEY_USER_ACTION
-> AssignedEntitiesTileSLO
-> AssignedEntitiesWithMetricTileSCALABLE_LIST
-> ScalableListTileHEADER
-> TileOPEN_PROBLEMS
-> ProblemTilePURE_MODEL
-> TileDOCKER
-> TileNETWORK_MEDIUM
-> TileAPPLICATIONS_MOST_ACTIVE
-> TileNETWORK
-> TileUEM_ACTIVE_SESSIONS
-> TileDCRUM_SERVICES
-> Tile
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
The TileBounds
object
The position and size of a tile.
The height of the tile, in pixels.
The horizontal distance from the top left corner of the dashboard to the top left corner of the tile, in pixels.
The vertical distance from the top left corner of the dashboard to the top left corner of the tile, in pixels.
The width of the tile, in pixels.
The TileFilter
object
A filter applied to a tile.
It overrides dashboard's filter.
The default timeframe of the tile.
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.
{"dashboardMetadata": {"dashboardFilter": {"managementZone": {"id": "3438779970106539862","name": "Example Management Zone"},"timeframe": "l_72_HOURS"},"dynamicFilters": {"filters": ["SERVICE_TYPE"]},"name": "Example Dashboard","owner": "Example Owner","shared": true},"metadata": {"clusterVersion": "Mock version","configurationVersions": [4,2]},"tiles": [{"bounds": {"height": 38,"left": 0,"top": 0,"width": 304},"configured": true,"name": "Hosts","tileFilter": {},"tileType": "HEADER"},{"bounds": {"height": 38,"left": 304,"top": 0,"width": 304},"configured": true,"name": "Applications","tileFilter": {},"tileType": "HEADER"},{"bounds": {"height": 304,"left": 0,"top": 38,"width": 304},"chartVisible": true,"configured": true,"name": "Host health","tileFilter": {"managementZone": {"id": "3438779970106539862","name": "Example Management Zone"}},"tileType": "HOSTS"},{"bounds": {"height": 304,"left": 304,"top": 38,"width": 304},"chartVisible": true,"configured": true,"name": "Application health","tileFilter": {"managementZone": {"id": "3438779970106539862","name": "Example Management Zone"}},"tileType": "APPLICATIONS"}]}
Response
Response codes
Success. The new dashboard has been created. Response doesn't have a body.
Success. The dashboard has been updated. Response doesn't have a body
Response body objects
The EntityShortRepresentation
object
The short representation of a Dynatrace entity.
A short description of the Dynatrace entity.
The ID of the Dynatrace entity.
The name of the Dynatrace entity.
Response body JSON model
{"description": "Dynatrace entity for the REST API example","id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a","name": "Dynatrace entity"}
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 | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/dashboards/{id}/validator |
Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/dashboards/{id}/validator |
Authentication
To execute this request, you need an access token with WriteConfig
scope.
To learn how to obtain and use it, see Tokens and authentication.
Response
POST | SaaS | https://{your-environment-id}.live.dynatrace.com/api/config/v1/dashboards/validator |
Environment ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/dashboards/validator |
Authentication
To execute this request, you need an access token with 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
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
https://mySampleEnv.live.dynatrace.com/api/config/v1/dashboards/2768e6ca-e199-4433-9e0d-2922aec2099b
Request body
{"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