• Home
  • Dynatrace API

Dynatrace API

Use the Dynatrace API to automate your monitoring tasks and export different types of data into your third-party reporting and analysis tools. API communication ensures safety by using secured communication via the HTTPS protocol.

Basics

Authentication
Response codes
Access limit

Preview and Early Adopter releases
Migration guides

Endpoints

ActiveGate

Information
Auto-update configuration
Auto-update jobs

Anonymization

Anonymization

Application Security

Security problems
Davis security advisor

Audit logs

Audit logs

Cluster information

Cluster information

Credential vault

Credential vault

Custom tags

Custom tags of monitored entities

Deployment

OneAgent
ActiveGate
BOSH tarballs
Orchestration tarballs

Events

List events
List event types
List event properties
Ingest events

Extensions 2.0

Extensions 2.0

Hub capabilities

Hub capabilities

Log Monitoring

Log Monitoring

Metrics

Version 1

Basics

Version 2

List metrics
Get data points
Ingest data points
Metric selector
Metric expressions

Metric units

List units
View a unit
Convert units

Monitored entities

Topology and Smartscape v1
Monitored entities v2

Network zones

Network zones

OneAgent on a host

OneAgent on a host

Problems

Problems v2

Releases

Releases

Remote configuration

OneAgent
ActiveGate

RUM

Geographic regions
User sessions
Real User Monitoring JavaScript
Browser extension

Settings

Settings

SLO

Service-level objectives

Synthetic

Monitors
Monitor executions v2
Locations v1
Locations v2
Nodes v1
Nodes v2
Third-party synthetic

Tokens

Tokens v2

Anomaly detection

Applications
AWS
Database services
Disk events
Hosts
Metric events
Process groups
Services
VMware

Auto tags

Automatically applied tags

AWS

AWS credentials
AWS PrivateLink
AWS supported services

Azure

Azure credentials
Azure supported services

Calculated metrics

Log Monitoring metrics
Mobile app metrics
Service metrics
Synthetic metrics
Web application metrics

Cloud Foundry

Cloud Foundry credentials

Conditional naming

Conditional naming

Data privacy

Data privacy

Dashboards

Dashboards

Extensions

Extensions
Plugins

Kubernetes

Kubernetes credentials

Management zones

Management zones
Copy management zones between Dynatrace environments

Mobile

Mobile and custom app configuration
Mobile symbolication

OneAgent

OneAgent on a host
OneAgent in a host group
Environment-wide configuration

Remote environments

Remote environments

Reports

Reports

RUM

Allowed beacon origins for CORS
Applications detection configuration
Calculated web application metrics
Content resources
Geographic regions - IP address mapping rules
Geographic regions - IP mapping headers
Mobile and custom app configuration
Web application configuration

Services

Calculated service metrics
Custom services
Failure detection
Request attributes
Request naming
Service detection rules

User management

View and manage Dynatrace users in your account.

Group management

View and manage user groups in your account.

Permission management

Manage user permissions in your account.

Policy management

Manage access policies in your account.

Quota management

Manage licensing quotas.

Environment management

View monitoring environments of your Dynatrace account.

Reference data

View the reference info about your account.

API Explorer

You can access all Dynatrace API endpoints using the API Explorer. To access the API Explorer, open the User menu in the upper-right corner of the Dynatrace web UI, scroll down to Dynatrace API, and select the API section you're interested in.

Alternatively, you can access the API Explorer via a direct link:

  • Dynatrace Managed https://{your-domain}/e/{your-environment-id}/rest-api-doc/
  • Dynatrace SaaS https://{your-environment-id}.live.dynatrace.com/rest-api-doc/

Authentication in the API Explorer

Select the lock icon next to any end point to display information about the API tokens that secure that endpoint. Each endpoint requires a specific token type.

You can also unlock all endpoints by selecting Authorize. In the displayed dialog, you can then see which token permissions are necessary for each API endpoint. By entering your API token into the global Available authorizations dialog, you can unlock all related API endpoints.

Try out an API call

Once you've entered your API token, you can directly execute API calls within the API explorer. Just select Try it out to open the parameter section of the selected API endpoint, where you can enter additional parameters and modify the request payload before executing it by selecting Execute.

You can access all Dynatrace API endpoints using the API Explorer. To access the API Explorer, open the User menu in the upper-right corner of the Dynatrace web UI, scroll down to Dynatrace API, and select the API section you're interested in.

Alternatively, you can access the API Explorer via a direct link:

  • Dynatrace Managed https://{your-domain}/e/{your-environment-id}/rest-api-doc/
  • Dynatrace SaaS https://{your-environment-id}.live.dynatrace.com/rest-api-doc/

Authentication in the API Explorer

Select the lock icon next to any end point to display information about the API tokens that secure that endpoint. Each endpoint requires a specific token type.

You can also unlock all endpoints by selecting Authorize. In the displayed dialog, you can then see which token permissions are necessary for each API endpoint. By entering your API token into the global Available authorizations dialog, you can unlock all related API endpoints.

Try out an API call

Once you've entered your API token, you can directly execute API calls within the API explorer. Just select Try it out to open the parameter section of the selected API endpoint, where you can enter additional parameters and modify the request payload before executing it by selecting Execute.

You can access all Dynatrace API endpoints using the API Explorer.

  1. Open the User menu in the upper-right corner of the Dynatrace web UI and go to Account settings > Account management API.
  2. Select the OpenAPI documentation link.

Authentication in the API Explorer

Select the lock icon next to any end point to display information about the API tokens that secure that endpoint. Each endpoint requires a specific token type.

You can also unlock all endpoints by selecting Authorize. In the displayed dialog, you can then see which token permissions are necessary for each API endpoint. By entering your API token into the global Available authorizations dialog, you can unlock all related API endpoints.

Try out an API call

Once you've entered your API token, you can directly execute API calls within the API explorer. Just select Try it out to open the parameter section of the selected API endpoint, where you can enter additional parameters and modify the request payload before executing it by selecting Execute.