Try it free

Synthetic API

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026
  • Early Access

Manage Dynatrace Synthetic monitors, locations, nodes, and on-demand executions, plus tenant-wide parameters and private locations.

Building a Dynatrace app?

Use the @dynatrace-sdk/client-synthetic SDK client instead of calling this API directly — it handles authentication, typing, and the environment URL for you. This REST reference is for external and automation use.

Overview

Dynatrace Synthetic API lets you manage synthetic monitoring resources and control how they run across your environment. It provides access to tenant-wide synthetic settings, synthetic locations and nodes, and on-demand execution workflows, so you can configure private locations, inspect available public and private locations, and trigger or rerun monitor executions when you need immediate validation. Typical usage includes automating synthetic monitor administration, provisioning private locations, and integrating execution control into operational or CI/CD processes.

Authentication

Platform API endpoints use Platform token and OAuth client authentication. Attach a platform token or OAuth access token to the Authorization HTTP header using the Bearer scheme.

--header 'Authorization: Bearer <platform-token-or-oauth-access-token>'

For details, see Tokens and authentication and Platform tokens.

Endpoints

  • Get synthetic configuration (GET /configuration)
  • Update synthetic configuration (PUT /configuration)
  • Trigger on-demand executions (POST /executions/batch)
  • Rerun an on-demand execution (POST /executions/{execution-id})
  • List synthetic locations (GET /locations)
  • Create a private synthetic location (POST /locations)
  • Get metric adapter deployment YAML (GET /locations/metric-adapter/yaml)
  • Get public location status (GET /locations/status)
  • Update public location status (PUT /locations/status)
  • Get a synthetic location (GET /locations/{location-id})
  • Update a synthetic location (PUT /locations/{location-id})
  • Delete a private synthetic location (DELETE /locations/{location-id})
  • Get location deployment YAML (GET /locations/{location-id}/yaml)
  • List synthetic monitors (GET /monitors)
  • Create a synthetic monitor (POST /monitors)
  • Get a synthetic monitor (GET /monitors/{monitor-id})
  • Update a synthetic monitor (PUT /monitors/{monitor-id})
  • Delete a synthetic monitor (DELETE /monitors/{monitor-id})
  • List synthetic nodes (GET /nodes)
  • Get a synthetic node (GET /nodes/{node-id})
Related tags
Platform APIDynatrace PlatformDigital Experience