Access tokens API - POST a token

Creates a new API token.

The token will be owned by the user who owns the token used to authenticate the call.

The request consumes and produces an application/json payload.

POST	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/v2/apiTokens`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/apiTokens`
	Environment and Cluster ActiveGate (default port 9999)	`https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/apiTokens`

Authentication

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

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
body	ApiTokenCreate	The JSON body of the request. Contains parameters of the new API token.	body	required

Request body objects

The `ApiTokenCreate` object

Parameters of a new API token.

Element	Type	Description	Required
expirationDate	string	The expiration date of the token. You can use one of the following formats: Timestamp in UTC milliseconds. Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional. Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week. You can also specify relative timeframe without an alignment: `now-NU`. Supported time units for the relative timeframe are: `m`: minutes `h`: hours `d`: days `w`: weeks `M`: months `y`: years If not set, the token never expires.	optional
name	string	The name of the token.	required
personalAccessToken	boolean	The token is a personal access token (`true`) or an API token (`false`). Personal access tokens are tied to the permissions of their owner.	optional
scopes	string[]	A list of the scopes to be assigned to the token. `InstallerDownload`: PaaS integration - Installer download. `DataExport`: Access problem and event feed, metrics, and topology. `PluginUpload`: Upload Extension. `SupportAlert`: PaaS integration - Support alert. `AdvancedSyntheticIntegration`: Dynatrace module integration - Synthetic Classic. `ExternalSyntheticIntegration`: Create and read synthetic monitors, locations, and nodes. `RumBrowserExtension`: RUM Browser Extension. `LogExport`: Read logs. `ReadConfig`: Read configuration. `WriteConfig`: Write configuration. `DTAQLAccess`: User sessions. `UserSessionAnonymization`: Anonymize user session data for data privacy reasons. `DataPrivacy`: Change data privacy settings. `CaptureRequestData`: Capture request data. `Davis`: Dynatrace module integration - Davis. `DssFileManagement`: Mobile symbolication file management. `RumJavaScriptTagManagement`: Real user monitoring JavaScript tag management. `TenantTokenManagement`: Token management. `ActiveGateCertManagement`: ActiveGate certificate management. `RestRequestForwarding`: Fetch data from a remote environment. `ReadSyntheticData`: Read synthetic monitors, locations, and nodes. `DataImport`: Data ingest, e.g.: metrics and events. `syntheticExecutions.write`: Write synthetic monitor executions. `syntheticExecutions.read`: Read synthetic monitor execution results. `auditLogs.read`: Read audit logs. `metrics.read`: Read metrics. `metrics.write`: Write metrics. `entities.read`: Read entities. `entities.write`: Write entities. `problems.read`: Read problems. `problems.write`: Write problems. `events.read`: Read events. `events.ingest`: Ingest events. `analyzers.read`: Read analyzers. `analyzers.write`: Write & execute analyzers. `networkZones.read`: Read network zones. `networkZones.write`: Write network zones. `activeGates.read`: Read ActiveGates. `activeGates.write`: Write ActiveGates. `activeGateTokenManagement.read`: Read ActiveGate tokens. `activeGateTokenManagement.create`: Create ActiveGate tokens. `activeGateTokenManagement.write`: Write ActiveGate tokens. `credentialVault.read`: Read credential vault entries. `credentialVault.write`: Write credential vault entries. `extensions.read`: Read extensions. `extensions.write`: Write extensions. `extensionConfigurations.read`: Read extension monitoring configurations. `extensionConfigurations.write`: Write extension monitoring configurations. `extensionEnvironment.read`: Read extension environment configurations. `extensionEnvironment.write`: Write extension environment configurations. `metrics.ingest`: Ingest metrics. `attacks.read`: Read attacks. `attacks.write`: Write Application Protection settings. `securityProblems.read`: Read security problems. `securityProblems.write`: Write security problems. `syntheticLocations.read`: Read synthetic locations. `syntheticLocations.write`: Write synthetic locations. `settings.read`: Read settings. `settings.write`: Write settings. `tenantTokenRotation.write`: Tenant token rotation. `slo.read`: Read SLO. `slo.write`: Write SLO. `releases.read`: Read releases. `apiTokens.read`: Read API tokens. `apiTokens.write`: Write API tokens. `openTelemetryTrace.ingest`: Ingest OpenTelemetry traces. `logs.read`: Read logs. `logs.ingest`: Ingest logs. `geographicRegions.read`: Read Geographic regions. `oneAgents.read`: Read OneAgents. `oneAgents.write`: Write OneAgents. `traces.lookup`: Look up a single trace. `hub.read`: Read Hub related data. `hub.write`: Manage metadata of Hub items. `hub.install`: Install and update Hub items. `javaScriptMappingFiles.read`: Read JavaScript mapping files. `javaScriptMappingFiles.write`: Write JavaScript mapping files. `InstallerDownload` `DataExport` `PluginUpload` `SupportAlert` `AdvancedSyntheticIntegration` `ExternalSyntheticIntegration` `RumBrowserExtension` `LogExport` `ReadConfig` `WriteConfig` `DTAQLAccess` `UserSessionAnonymization` `DataPrivacy` `CaptureRequestData` `Davis` `DssFileManagement` `RumJavaScriptTagManagement` `TenantTokenManagement` `ActiveGateCertManagement` `RestRequestForwarding` `ReadSyntheticData` `DataImport` `syntheticExecutions.write` `syntheticExecutions.read` `auditLogs.read` `metrics.read` `metrics.write` `entities.read` `entities.write` `problems.read` `problems.write` `events.read` `events.ingest` `analyzers.read` `analyzers.write` `networkZones.read` `networkZones.write` `activeGates.read` `activeGates.write` `activeGateTokenManagement.read` `activeGateTokenManagement.create` `activeGateTokenManagement.write` `credentialVault.read` `credentialVault.write` `extensions.read` `extensions.write` `extensionConfigurations.read` `extensionConfigurations.write` `extensionEnvironment.read` `extensionEnvironment.write` `metrics.ingest` `attacks.read` `attacks.write` `securityProblems.read` `securityProblems.write` `syntheticLocations.read` `syntheticLocations.write` `settings.read` `settings.write` `tenantTokenRotation.write` `slo.read` `slo.write` `releases.read` `apiTokens.read` `apiTokens.write` `openTelemetryTrace.ingest` `logs.read` `logs.ingest` `geographicRegions.read` `oneAgents.read` `oneAgents.write` `traces.lookup` `hub.read` `hub.write` `hub.install` `javaScriptMappingFiles.read` `javaScriptMappingFiles.write`	required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

1{
2  "expirationDate": "now+14d",
3  "name": "tokenName",
4  "personalAccessToken": false,
5  "scopes": [
6    "metrics.read"
7  ]
8}

Response

Response codes

Code	Type	Description
201	ApiTokenCreated	Success. The token has been created. The body of the response contains the token secret.
400	ErrorEnvelope	Failed. The input is invalid.

Response body objects

The `ApiTokenCreated` object

The newly created token.

Element	Type	Description
expirationDate	string	The token expiration date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).
id	string	The ID of the token, consisting of prefix and public part of the token.
token	string	The secret of the token.

Response body JSON model

1{
2  "expirationDate": "2020-11-12T08:15:30.144Z",
3  "id": "dt0c01.ST2EY72KQINMH574WMNVI7YN",
4  "token": "dt0c01.ST2EY72KQINMH574WMNVI7YN.G3DFPBEJYMODIDAEX454M7YWBUVEFOWKPRVMWFASS64NFH52PX6BNDVFFM572RZM"
5}