Try it free

Synthetic monitors API v2 - DELETE Synthetic monitor

  • Reference

Deletes an existing Synthetic monitor. Deletion cannot be undone.

The method is available only for browser and NAM monitors.

DELETESaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/synthetic/monitors/{monitorId}
DELETEEnvironment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/synthetic/monitors/{monitorId}

Authentication

Api-Token:

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

One of the following permissions is required for personal access tokens:

  • environment:roles:manage-settings

To learn how to obtain and use it, see Personal access tokens.

Parameters

ParameterTypeDescriptionInRequired
monitorIdstring

The identifier of the monitor.

pathRequired

Response

Response codes

CodeTypeDescription
204-

Success. Response doesn't have a body.

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}

Related topics

  • Synthetic Monitoring Classic