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:
Dynatrace uses a unique token format consisting of three components separated by dots (.).
dt0s01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM
Component name
Component description
prefix
The prefix identifies the token type.
In our example: dt0s01
See Token prefixes below for a table of standard prefixes.
public portion
The public portion of the token is a 24-character public identifier.
In our example: ST2EY72KQINMH574WMNVI7YN
token identifier
The token identifier is the combination of the prefix and the public portion. A token identifier can be safely displayed in the UI and can be used for logging purposes.
In our example: dt0s01.ST2EY72KQINMH574WMNVI7YN
secret portion
The secret portion of the token is a 64-character string that should be treated like a password:
In our example: G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM
Prefix
Description
dt0s01
This is an API token. It's used as an authorization method: a valid token allows the user to make changes within the Dynatrace account through SCIM.
dt0s01 token.dt0s02
OAuth2 Clients created by users through Account Management to be used with Dynatrace Apps and Account Management API.
dt0s03
OAuth2 Clients for internal and external services and integrations.
dt0s04
Chat and identity linking.
dt0s06
This is an OAuth2 Refresh Token, which is used to retrieve a new Access Token and generally changes frequently (typically every 5 to 15 minutes).
dt0s08
OAuth2 Clients for internal and external services and integrations.
dt0s09
Chat and identity linking.
dt0s16
Platform Token enabling programmatic access to Dynatrace platform services.
The predictable format gives you several advantages, such as:
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.
For a limited time, you have the option to opt out of using the new token format. To find the setting, in the CMC web UI, go to Settings > API tokens.
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.
Name
API value
Description
Create ActiveGate tokens
activeGateTokenManagement.create
Grants access to the POST request of the ActiveGate tokens API.
Read ActiveGate tokens
activeGateTokenManagement.read
Grants access to GET requests of the ActiveGate tokens API.
Write ActiveGate tokens
activeGateTokenManagement.write
Grants access to POST and DELETE requests of the ActiveGate tokens API.
Write API tokens
apiTokens.write
Grants access to POST, PUT, and DELETE requests of the Access tokens API.
Read attacks
attacks.read
Grants access to GET requests of the Attacks API and the Settings API for Application Protection (builtin:appsec.attack-protection-settings, builtin:appsec.attack-protection-advanced-config, and builtin:appsec.attack-protection-allowlist-config schemas).
Write Application Protection settings
attacks.write
Grants access to POST, PUT, and DELETE requests of the Settings API for Application Protection (builtin:appsec.attack-protection-settings, builtin:appsec.attack-protection-advanced-config, and builtin:appsec.attack-protection-allowlist-config schemas).
Read credential vault entries
credentialVault.read
Grants access to GET requests of the Credential vault API.
Write credential vault entries
credentialVault.write
Grants access to POST, PUT, and DELETE requests of the Credential vault API.
Read entities
entities.read
Grants access to GET requests of the Monitored entities and Custom tags APIs.
Write entities
entities.write
Grants access to POST, PUT, and DELETE requests of the Monitored entities and Custom tags APIs.
Read extensions monitoring configuration
extensionConfigurations.read
Grants access to GET requests from the Extensions monitoring configuration section of the Extensions 2.0 API.
Write extensions monitoring configuration
extensionConfigurations.write
Grants access to POST, PUT, and DELETE requests from the Extensions monitoring configuration section of the Extensions 2.0 API.
Read extensions environment configuration
extensionEnvironment.read
Grants access to GET requests from the Extensions environment configuration section of the Extensions 2.0 API.
Write extensions environment configuration
extensionEnvironment.write
Grants access to POST, PUT, and DELETE requests from the Extensions environment configuration section of the Extensions 2.0 API.
Read extensions
extensions.read
Grants access to GET requests from the Extensions section of the Extensions 2.0 API.
Write extensions
extensions.write
Grants access to POST, PUT, and DELETE requests from the Extensions section of the Extensions 2.0 API.
Install and update Hub items
hub.install
Grants permission to install and update extensions via the Hub items API.
Manage metadata of Hub items
hub.write
Grants permission to manage metadata of Hub items via the Hub items API.
Read JavaScript mapping files
javaScriptMappingFiles.read
Write JavaScript mapping files
javaScriptMappingFiles.write
Ingest logs
logs.ingest
Grants access to the POST ingest logs request of the Log Monitoring API v2 as well as the OpenTelemetry log ingest API.
Ingest metrics
metrics.ingest
Grants access to the POST ingest data points request of the Metrics v2 API as well as the OpenTelemetry metrics ingest API.
Write metrics
metrics.write
Grants access to the DELETE a custom metric request of the Metrics API v2.
Write network zones
networkZones.write
Grants access to POST, PUT, and DELETE requests of the Network zones API.
Ingest OpenTelemetry traces
openTelemetryTrace.ingest
Grants permission to ingest OpenTelemetry traces.
Read security problems
securityProblems.read
Grants access to GET requests of the Security problems API.
Write security problems
securityProblems.write
Grants access to POST requests of the Security problems API.
Write SLO
slo.write
Grants access to POST, PUT, and DELETE requests of the Service-level objectives API.
Read synthetic monitor execution results
syntheticExecutions.read
Grants access to GET requests of the /synthetic/executions API.
Write synthetic monitor execution results
syntheticExecutions.write
Grants access to POST request of /synthetic/executions API.
Read synthetic locations
syntheticLocations.read
Grants access to GET requests of the Synthetic locations API v2 and Synthetic nodes API v2.
Write synthetic locations
syntheticLocations.write
Grants access to POST, PUT, and DELETE requests of the Synthetic locations API v2 and Synthetic nodes API v2.
Look up a single trace
traces.lookup
Checks for the presence of a trace in cross-environment tracing.
Read Unified Analysis page
unifiedAnalysis.read
Grants access to the Unified analysis schema in the Settings API.
Access problems and event feed, metrics, and topology
DataExport
Grants access to various calls of Environment API.
Create and read synthetic monitors, locations, and nodes
ExternalSyntheticIntegration
Grants access to the Synthetic API.
Read synthetic monitors, locations, and nodes
ReadSyntheticData
Grants access to GET requests of Synthetic API.
Change data privacy settings
DataPrivacy
Grants access to Data privacy API and data privacy calls of Web application configuration API.
Anonymize user sessions for data privacy reasons
UserSessionAnonymization
Grants access to Anonymization API.
Real User Monitoring JavaScript tag management
RumJavaScriptTagManagement
Grants access to Real User Monitoring JavaScript API.
ActiveGate certificate management
ActiveGateCertManagement
Grants permission to configure certificate on private ActiveGates.
Fetch data from a remote environment
RestRequestForwarding
Grants permission to fetch data from remote Dynatrace environments for multi-environment dashboarding.
Download OneAgent and ActiveGate installers
InstallerDownload
Allows download of installers via Deployment API.
Upload plugins using the command line
PluginUpload
Grants permission to upload OneAgent extensions via Extension SDK.
To generate an API token
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 Access 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 tokens are used to download OneAgent and ActiveGate installers. To generate a PaaS token
Alternatively, you can use the POST a new token API call to generate a token with the InstallerDownload and SupportAlert permissions.
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.
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.
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 classic.
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.
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
To generate a personal access token
You can only access your token once upon creation. You can't reveal it afterward.
Dynatrace provides the following permissions for personal access tokens. You can set them in the web UI as described above or via the Access tokens API.
Name
API value
Description
Write API tokens
apiTokens.write
Grants access to POST, PUT, and DELETE requests of the Access tokens API.
Read entities
entities.read
Grants access to GET requests of the Monitored entities and Custom tags APIs.
Write entities
entities.write
Grants access to POST, PUT, and DELETE requests of the Monitored entities and Custom tags APIs.
Write metrics
metrics.write
Grants access to the DELETE a custom metric request of the Metrics API v2.
Write network zones
networkZones.write
Grants access to POST, PUT, and DELETE requests of the Network zones API.
Read security problems
securityProblems.read
Grants access to GET requests of the Security problems API.
Write security problems
securityProblems.write
Grants access to POST requests of the Security problems API.
Write SLO
slo.write
Grants access to POST, PUT, and DELETE requests of the Service-level objectives API.