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	ManagedDynatrace for Government	`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`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v1/synthetic/ext/stateModifications`

Authentication

To execute this request, you need an access token with ExternalSyntheticIntegration scope.

To learn how to obtain and use it, see Tokens and authentication.

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

Request body objects

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 element can hold these values `ACTIVE` `HIDDEN` `INACTIVE`	required

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
{
  "state": "ACTIVE"
}

Response

Response codes

Code	Type	Description
204		Success. The state of third-party monitors has been changed.
400	ErrorEnvelope	Failed. The input is invalid.

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

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

Request URL

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

Request body

json
{
  "state": "ACTIVE"
}

Response code

204