Synthetic locations API v2 - DELETE a location

  • Reference
  • Published Jul 26, 2019

Deletes an existing private synthetic location. Deletion cannot be undone.

DELETESaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/locations/{locationId}
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/synthetic/locations/{locationId}

Authentication

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

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

Parameters

ParameterTypeDescriptionInRequired
locationIdstring

The Dynatrace entity ID of the private synthetic location to be deleted.

pathrequired

Response

Response codes

CodeTypeDescription
204-

Success. The location has been deleted. Response doesn't have a body.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Example

In this example, the request deletes the private Synthetic location from the POST request example. The response code of 204 indicates that the deletion was successful.

The API token is passed in the Authorization header.

Curl

curl -X DELETE \
https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC \
-H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v2/synthetic/locations/SYNTHETIC_LOCATION-493122BFA29674DC

Response code

204