• Home
  • Get started with Dynatrace
  • Access tokens

Access tokens

All external access to your Dynatrace monitoring environment relies on two pieces of information: the environment ID and an access token.

Dynatrace uses several types of tokens:

  • API tokens and personal access tokens grant access to the Dynatrace API
  • PaaS tokens allow download of OneAgent and ActiveGate installers
  • Tenant tokens allow OneAgent to report data to Dynatrace
  • Module tokens grant access to module integrations.

Token format

Dynatrace uses a unique token format consisting of three components separated by dots (.).

dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM

dt0c01Prefix to identify the token.
ST2...7YN

Public portion of token

A 24-character public identifier of the token. This value can be safely displayed in the UI and can be used for logging purposes.

G3D...RZM

Secret portion of token

A 64-character secret portion of the token, which can be treated like a password and therefore doesn’t need to be displayed in the Dynatrace web UI (following initial creation) or stored in log files.

The predictable format gives you several advantages, such as:

  • Using Git pre-commit hooks to avoid pushing tokens to source code repositories (for example, using tools like git-secrets)
  • Defining masking rules to obfuscate the secret portions of tokens when writing log files
  • Detecting tokens in internal files or communications
  • Enabling the GitHub secret scanning service to identify any token pushed to a public GitHub repository

Use this regular expression to look for tokens:

dt0[a-zA-Z]{1}[0-9]{2}\.[A-Z0-9]{24}\.[A-Z0-9]{64}

With the rollout of Dynatrace version 1.210, this format is enabled by default (all newly generated tokens will use the new format).

All existing tokens of the old format remain valid.

Disable the new format

For a limited time, you have the option to opt out of using the new token format. You can find the setting here:

  • SaaS and environment-wide Managed Go to Settings > Integration > Token settings.
  • Managed cluster In the CMC web UI, go to Settings > API tokens.

API token

API tokens are used by Dynatrace API to authenticate various API calls. API tokens have fine-grained scopes to limit access to specific product functionality for security reasons.

Token scopes

View available scopes

Dynatrace provides the following permissions for API tokens. You can set them in the UI as described above or via the API authentication tokens API. Some scopes are only available via API.

NameAPI valueDescription

API v2

Read metricsmetrics.readGrants access to GET requests of the Metrics API v2.
Write metricsmetrics.writeGrants access to the DELETE a custom metric request of the Metrics API v2.
Ingest metricsmetrics.ingestGrants access to the POST ingest data points request of the Metrics v2 API.
Read logslogs.readGrants access to the GET requests of the Log Monitoring API v2
Ingest logslogs.ingestGrants access to the POST ingest logs request of the Log Monitoring API v2.
Ingest OpenTelemetry tracesopenTelemetryTrace.ingestAllows to ingest OpenTelemetry traces.
Read entitiesentities.readGrants access to GET requests of the Monitored entities and Custom tags APIs.
Write entitiesentities.writeGrants access to POST, PUT, and DELETE requests of the Monitored entities and Custom tags APIs.
Read problemsproblems.readGrants access to GET requests of the Problems API v2.
Write problemsproblems.writeGrants access to POST, PUT, and DELETE requests of the Problems API v2.
Read eventsevents.readGrants access to GET requests of the Events API v2.
Ingest eventsevents.ingestGrants access to POST request of the Events API v2.
Read network zonesnetworkZones.readGrants access to GET requests of the Network zones API.
Write network zonesnetworkZones.writeGrants access to POST, PUT, and DELETE requests of the Network zones API.
Read ActiveGatesactiveGates.readGrants access to GET requests of the ActiveGates API.
Write ActiveGatesactiveGates.writeGrants access to POST and DELETE requests of the ActiveGates API.
Read ActiveGate tokensactiveGateTokenManagement.readGrants access to GET requests of the ActiveGate tokens API.
Create ActiveGate tokensactiveGateTokenManagement.createGrants access to the POST request of the ActiveGate tokens API.
Write ActiveGate tokensactiveGateTokenManagement.writeGrants access to POST and DELETE requests of the ActiveGate tokens API.
Read extensionsextensions.readGrants access to GET requests from the Extensions section of the Extensions 2.0 API.
Write extensionsextensions.writeGrants access to POST and DELETE requests from the Extensions section of the Extensions 2.0 API.
Read extensions environment configurationextensionEnvironment.readGrants access to GET requests from the Extensions environment configuration section of the Extensions 2.0 API.
Write extensions environment configurationextensionEnvironment.writeGrants access to POST, PUT, and DELETE requests from the Extensions environment configuration section of the Extensions 2.0 API.
Read extensions monitoring configurationextensionConfigurations.readGrants access to GET requests from the Extensions monitoring configuration section of the Extensions 2.0 API.
Write extensions monitoring configurationextensionConfigurations.writeGrants access to POST, PUT, and DELETE requests from the Extensions monitoring configuration section of the Extensions 2.0 API.
Read security problemssecurityProblems.readGrants access to GET requests of the Security problems API.
Write security problemssecurityProblems.writeGrants access to POST requests of the Security problems API.
Read synthetic locationssyntheticLocations.readGrants access to GET requests of the Synthetic locations API v2 and Synthetic nodes API v2.
Write synthetic locationssyntheticLocations.writeGrants access to POST, PUT, and DELETE requests of the Synthetic locations API v2 and Synthetic nodes API v2.
Read settingssettings.readGrants access to GET requests of the Settings API.
Write settingssettings.writeGrants access to POST and DELETE requests of the Settings API.
Tenant token rotationtenantTokenRotation.writeGrants access to the Tenant tokens API.
Read SLOslo.readGrants access to GET requests of the Service level objectives API.
Write SLOslo.writeGrants access to POST, PUT, and DELETE requests of the Service level objectives API.
Read API tokensapiTokens.readGrants access to GET requests of the Access tokens API.
Write API tokensapiTokens.writeGrants access to POST, PUT, and DELETE requests of the Access tokens API.
Read releasesreleases.readGrants access to the Releases API.
Read audit logsauditLogs.readGrants access to the audit log.

API v1

Read credential vault entriescredentialVault.readGrants access to GET requests of the Credential vault API.
Write credential vault entriescredentialVault.writeGrants access to POST, PUT, and DELETE requests of the Credential vault API.
Access problems and event feed, metrics, and topologyDataExportGrants access to various calls of Environment API.
Create and read synthetic monitors, locations, and nodesExternalSyntheticIntegrationGrants access to the Synthetic API.
Read synthetic monitors, locations, and nodesReadSyntheticDataGrants access to GET requests of Synthetic API.
Read configurationReadConfigGrants access to GET calls of Configuration API.
Write configurationWriteConfigGrants access to POST, PUT, and DELETE calls of Configuration API.
Change data privacy settingsDataPrivacyGrants access to Data privacy API and data privacy calls of Web application configuration API.
User sessionsDTAQLAccessGrants access to User sessions API.
Anonymize user sessions for data privacy reasonsUserSessionAnonymizationGrants access to Anonymization API.
Mobile symbolication file managementDssFileManagementGrants access to Mobile symbolication API.
Real User Monitoring JavaScript tag managementRumJavaScriptTagManagementGrants access to Real User Monitoring JavaScript API.
Token managementTenantTokenManagementAllows to create and delete tokens as well as view their metadata via Tokens API.
ActiveGate certificate managementActiveGateCertManagementAllows to configure certificate on private ActiveGates.
Data ingestDataImportAllows to import data and events from external sources.
Fetch data from a remote environmentRestRequestForwardingAllows to fetch data from remote Dynatrace environments for multi-environment dashboarding.
Capture request dataCaptureRequestDataGrants access to Request attributes API.
Read log contentLogExportGrants access to Log Monitoring API.
RUM browser extensionRumBrowserExtensionAllows the RUM browser extension to send data to Dynatrace.

PaaS

Download OneAgent and ActiveGate installersInstallerDownload

Allows download of installers via Deployment API.

Create support alertsSupportAlert

Allows creation of support alerts for crash analysis.

Other

Upload plugins using the command linePluginUploadAllows to upload OneAgent extensions via command line tool.

Create an API token

To generate an API token

  1. In the Dynatrace menu, select Settings.
  2. Go to Integration > Dynatrace API.
  3. Select Generate token.
  4. Enter a name for your token.
  5. Select the required permissions for the token.
  6. Select Generate.
  7. Copy the generated token to the clipboard. Store the token in a password manager for future use.

    You can only access your token once upon creation. You can't reveal it afterwards.

You can assign multiple permissions to a single token, or you can generate several tokens, each with different access levels and use them accordingly—check your organization's security policies for the best practice.

Alternatively, you can use the POST a token call of the API authentication tokens API to generate a token.

Dynatrace doesn't enforce unique token names. You can create multiple tokens with the same name. Be sure to provide a meaningful name for each token you generate. Proper naming helps you to efficiently manage your tokens and perhaps delete them when they're no longer needed.

PaaS token

PaaS tokens are used to download OneAgent and ActiveGate installers. To generate a PaaS token

  1. Sign in using your Dynatrace account.
  2. In the Dynatrace menu, go to Settings and select Integration > Platform as a Service.
  3. Select Generate token.
  4. Enter a meaningful name for your PaaS token. For instance, a meaningful token name might be the name of the PaaS platform you want to monitor (azure, cloud-foundry, openshift, etc).
  5. Select Generate to create the PaaS token. The newly created PaaS token is added to the Platform as a Service tokens.

    The PaaS token is essentially an API token used in combination with your environment ID to download OneAgent.

  6. Select Copy to copy the generated token to the clipboard. Store the token in a password manager for future use.

    You can only access your token once upon creation. You can't reveal it afterwards.

Alternatively, you can use the POST a new token API call to generate a token with the InstallerDownload and SupportAlert permissions.

Tenant token

The tenant token is used by OneAgents and ActiveGates to report data to Dynatrace. Dynatrace automatically generates the tenant token and adds it to OneAgent and ActiveGate installers on download.

Access a tenant token

To obtain a tenant token for your environment, execute the GET connectivity information for OneAgent request of the Deployment API. You will find the tenant token in the tenantToken field of the response body. You'll need your PaaS token to authenticate the request.

Rotate tenant token

You can change the tenant token as needed (for example, to adhere to internal security policies or respond to unintended exposure). The procedure for changing the tenant token is called tenant token rotation. To learn how to rotate tenant tokens, see Tenant token.

Personal access token

All the above mentioned tokens require admin rights to generate. With personal access tokens, you can generate a token for API usage without admin rights. Available scopes are bound to your permissions, meaning that you can only use the API counterparts of features you're already authorized to use. You're also limited to the data from management zones you have access to.

A personal access token is bound to you. You can't generate a personal access token for another user.

Enable personal access tokens

Admin rights are required to enable this feature. After it's enabled, any user can generate a personal access token.

To enable personal access tokens

  1. In the Dynatrace menu, go to Settings and select Integration > Token settings.
  2. Turn on Enable personal access tokens.

Generate personal access tokens

To generate a personal access token

  1. Select the user menu in the upper-right corner of the page.
  2. Select Personal access tokens.
  3. Select Generate new token.
  4. Enter a name for your token.
    Dynatrace doesn't enforce unique token names. You can create multiple tokens with the same name. Be sure to provide a meaningful name for each token you generate. Proper naming helps you to efficiently manage your tokens and perhaps delete them when they're no longer needed.
  5. Select the required scopes for the token.
  6. Select Generate.
  7. Copy the generated token to the clipboard. Store the token in a password manager for future use.

    You can only access your token once upon creation. You can't reveal it afterwards.

Token scopes

View available scopes

Dynatrace provides the following permissions for personal access tokens. You can set them in the UI as described above or via the API authentication tokens API.

NameAPI valueDescription
Read API tokensapiTokens.readGrants access to GET requests of the Access tokens API.
Write API tokensapiTokens.writeGrants access to POST, PUT, and DELETE requests of the Access tokens API.
Read entitiesentities.readGrants access to GET requests of the Monitored entities and Custom tags APIs.
Write entitiesentities.writeGrants access to POST, PUT, and DELETE requests of the Monitored entities and Custom tags APIs.
Read metricsmetrics.readGrants access to GET requests of the Metrics API v2.
Write metricsmetrics.writeGrants access to the DELETE a custom metric request of the Metrics API v2.
Read network zonesnetworkZones.readGrants access to GET requests of the Network zones API.
Write network zonesnetworkZones.writeGrants access to POST, PUT, and DELETE requests of the Network zones API.
Read problemsproblems.readGrants access to GET requests of the Problems API v2.
Write problemsproblems.writeGrants access to POST, PUT, and DELETE requests of the Problems API v2.
Read releasesreleases.readGrants access to the Releases API.
Read security problemssecurityProblems.readGrants access to GET requests of the Security problems API.
Write security problemssecurityProblems.writeGrants access to POST requests of the Security problems API.
Read settingssettings.readGrants access to GET requests of the Settings API.
Write settingssettings.writeGrants access to POST and DELETE requests of the Settings API.
Read SLOslo.readGrants access to GET requests of the Service level objectives API.
Write SLOslo.writeGrants access to POST, PUT, and DELETE requests of the Service level objectives API.