• Home
  • Dynatrace API
  • Configuration
  • Calculated metrics
  • Synthetic
  • PUT a metric

Synthetic metrics API - PUT a metric

Updates the descriptor of the specified calculated synthetic metric.

The request consumes and produces an application/json payload.

PUTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/synthetic/{metricKey}
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/synthetic/{metricKey}
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/synthetic/{metricKey}

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

ParameterTypeDescriptionInRequired
metricKeystring

The key of the calculated synthetic metric to be updated.

pathrequired
bodySyntheticMetricUpdate

The JSON body of the request. Contains the update to the calculated synthetic metric.

bodyoptional

Request body objects

The SyntheticMetricUpdate object

The update of the calculated synthetic metric.

ElementTypeDescriptionRequired
enabledboolean

The metric is enabled (true) or disabled (false).

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
{ "enabled": true }

Response

Response codes

CodeTypeDescription
204

Success. The calculated synthetic metric has been updated. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid

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.

The request consumes an application/json payload.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/synthetic/{metricKey}/validator
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/synthetic/{metricKey}/validator
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/synthetic/{metricKey}/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

Response codes

CodeTypeDescription
204

Validated. The submitted calculated synthetic metric is valid. The response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.

Related topics
  • Synthetic Monitoring

    Learn about Synthetic Monitoring and how to create a single-URL browser monitor, a browser clickpath, or an HTTP monitor.