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
Endpoints
Anonymization
Application Security
Audit logs
Cluster information
Credential vault
Custom tags
Extensions 2.0
Hub capabilities
Log Monitoring
Metrics
Version 1
Version 2
List metrics
Get data points
Ingest data points
Metric selector
Metric expressions
Metric units
Monitored entities
Network zones
OneAgent on a host
Problems
Releases
Remote configuration
Settings
Tokens
Anomaly detection
Applications
AWS
Database services
Disk events
Hosts
Process groups
Services
VMware
Auto tags
Cloud Foundry
Conditional naming
Data privacy
Dashboards
Extensions
Kubernetes
Management zones
Management zones
Copy management zones between Dynatrace environments
Remote environments
Reports
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.
Environment management
View monitoring environments of your Dynatrace account.
Dynatrace Platfrom Subscription
View your Dynatrace Platform Subscription and how it is used.
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.
- Open the User menu
in the upper-right corner of the Dynatrace web UI and go to Account settings > Account management API.
- 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.