Third-party synthetic API - POST modify state of third-party monitors

Modifies the operation state of all third-party monitors.

The request consumes an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/synthetic/ext/stateModifications
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/v1/synthetic/ext/stateModifications

Parameters

Parameter Type Description In Required
body StateModification

The JSON body of the request. Contains new operational status of third-party synthetic monitors.

body required

The StateModification object

Operation state to be set for all third-party Synthetic monitors

Element Type Description Required
state string

The new operation state for all third-party Synthetic monitors.

The state element can hold these values.
required

Possible values

Possible values for the state element in the StateModification object:

  • ACTIVE
  • HIDDEN
  • INACTIVE

Response format

A successful request doesn't return any content.

Example

In this example, the request sets the state of third-party monitors to active.

The API token is passed in the Authorization header.

Curl

curl -X POST \
  https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/ext/stateModifications \
  -H 'Authorization: Api-Token abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{
  "state": "ACTIVE"
}
'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/ext/stateModifications

Request body

{
  "state": "ACTIVE"
}

Response code

204