Synthetic metrics API - PUT a metric

Updates the descriptor of the specified calculated synthetic metric.

The request consumes and produces an application/json payload.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/synthetic/{metricKey}
Environment ActiveGatehttps://{your-activegate-domain}:9999/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

Parameter
Type
Description
In
Required
metricKey
string

The key of the calculated synthetic metric to be updated.

path
required
body

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

body
optional

Request body objects

The SyntheticMetricUpdate object

The update of the calculated synthetic metric.

Element
Type
Description
Required
enabled
boolean

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.

{
"enabled": true
}

Response

Response codes

Code
Type
Description
204
-

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

400

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.

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

Code
Type
Description
204
-

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

400

Failed. The input is invalid.