Try it free

Migrate Synthetic API automation

  • Latest Dynatrace
  • How-to guide
  • 5-min read

If you use the Synthetic API to automate monitor management (for example, in CI/CD pipelines, scripts, or workflows), you need to migrate those API calls from the Classic Environment API to the Synthetic Platform API. This applies to all monitor types: browser, HTTP, and network availability. If you manage monitors only through the UI, skip this page.

What changes

AreaClassic (Environment API v1/v2)Latest Dynatrace (Platform API)

Base URL

https://{environmentId}.live.dynatrace.com/api/v2/synthetic/

https://{environmentId}.apps.dynatrace.com/platform/synthetic/v1/

Authentication

Classic API token (dt0c01.*) with Api-Token header

Platform token (dt0s16.*) or OAuth client with Bearer header

Authorization model

Token scopes (for example, syntheticTokenManagement.read)

IAM policies; the token inherits the user's permissions

Monitor CRUD

Deprecated since sprint 340

Available (Early Adopter)

Locations, nodes, executions

Active on Environment API v2

Use Environment API v2 until Platform API equivalents are available

Migrate authentication

The Platform API does not accept Classic API tokens. Replace them with Platform tokens for user-context automation or OAuth client credentials for service-to-service automation.

Platform tokens

  1. Go to your user profile and select My platform tokens.
  2. Create a token. The token inherits the IAM permissions of your user account, so no separate scope selection is needed.
  3. Use the token with the Authorization: Bearer <token> header.

OAuth clients

For service-to-service automation (CI/CD pipelines, scheduled scripts, workflows)

  1. Create an OAuth client in Account Management > Identity & access management > OAuth clients.
  2. Assign the required IAM policies to the client.
  3. Request an access token using the client credentials grant and use it with the Bearer header.

For the full token migration procedure, see Upgrade from access tokens (Classic).

Update API calls

Replace the base URL and authentication in your existing automation:

Before (Classic Environment API).

curl -X GET "https://{environmentId}.live.dynatrace.com/api/v2/synthetic/monitors" \
-H "Authorization: Api-Token dt0c01.XXXXXXXX.YYYYYYYY"

After (Synthetic Platform API).

curl -X GET "https://{environmentId}.apps.dynatrace.com/platform/synthetic/v1/monitors" \
-H "Authorization: Bearer dt0s16.XXXXXXXX.YYYYYYYY"

Locations, nodes, and execution result endpoints remain on the Environment API v2 (/api/v2/synthetic/locations, /api/v2/synthetic/nodes, /api/v2/synthetic/executions). Use these endpoints until Platform API equivalents are available.

Required permissions

The Platform API uses IAM permissions instead of token scopes. Make sure that the user who creates the platform token, or the OAuth client, has the permissions listed in Required permissions.

API specification

The Platform API OpenAPI specification is available at:

https://{environmentId}.apps.dynatrace.com/platform/synthetic/v1/openapi.yaml

Use it to generate clients or review available endpoints, request and response schemas, and query parameters.

Verify the migration

For each automated workflow that uses the Synthetic API:

  • Confirm that the base URL and authentication use the Platform API.
  • Confirm that the automation runs successfully with the new token or OAuth client.
  • Confirm that monitors are created, updated, and deleted as expected.
  • Keep the Classic API automation available for rollback until your environment is upgraded to the latest Dynatrace.

Related topics

  • Upgrade Synthetic Monitoring
  • Upgrade from classic access tokens to platform tokens
  • Access control
  • Synthetic API v2
Related tags
Digital Experience