Synthetic locations API - DELETE a location

We have a new version of this API—Synthetic API v2. Check it out!

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

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

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
locationId
string

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

path
required

Response

Response codes

Code
Type
Description
4XX

Client side error.

5XX

Server side error.

default
-

default response

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/v1/synthetic/locations/SYNTHETIC_LOCATION-8F419D1B53639A45 \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dynatrace.com/api/v1/synthetic/locations/SYNTHETIC_LOCATION-8F419D1B53639A45

Response code

204

Related topics