Synthetic metrics API - PUT a metric

Updates the definition of the specified calculated synthetic metric.

The request consumes and produces an application/json payload.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

PUT
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/synthetic/{metricKey}
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/synthetic/{metricKey}

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. 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 SyntheticMetricUpdate

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

body optional

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

Response format

Response codes

Code 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.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/calculatedMetrics/synthetic/{metricKey}/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/calculatedMetrics/synthetic/{metricKey}/validator

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response codes

Code Description
204 Validated. The submitted calculated synthetic metric is valid. The response doesn't have a body.
400 Failed. The input is invalid.