External synthetic API - POST modify state of external monitors

Modifies the operation state of all external 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.dexp.ae/api/v1/synthetic/ext/stateModifications

Authentication

To execute this request, you need the Create and configure Synthetic monitors permission assigned to your API token. See the Authentication page to learn how to obtain and use it.

Parameters

Parameter	Type	Description	In	Required
body	StateModification	The JSON body of the request, containing new operational status of external synthetic monitors.	body	required

Request parameters JSON model

The StateModification object

Operation state to be set for all external Synthetic monitors

Element	Type	Description	Required
state	string	The new operation state for all external Synthetic monitors. The state element can hold these values.	required

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.

      
  {
  "state": "ACTIVE"
}

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 external monitors to active.

The API token is passed in the Authorization header.

Curl

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

Request URL

https://mySampleEnv.live.dexp.ae/api/v1/synthetic/ext/stateModifications

Request body

{
  "state": "ACTIVE"
}

Response code

204