Classic environment service
The classic environment service is a convenience service that mirrors most APIs already available in your existing Dynatrace environment. The service allows you to use these APIs inside AppEngine and AutomationEngine. That will enable you to use the full power of Dynatrace inside your apps and workflows.
The classic service only covers a subset of APIs of your Dynatrace environment since a lot of the functionality is available to you via the new platform services.
Remember to use our new platform services and Grail as the preferred option to access data inside Dynatrace and only fall back to the classic services if necessary.
Concepts
You need to know the following concepts to work with the classic environment service.
Authentication and access control
The classic endpoints are authorized via OAuth and enforce the user's permissions in the backend. The environment role-based permissions are mapped onto the existing endpoints to make the environment endpoints consumable in a user context for app development. When using these APIs in apps and workflows, the whole OAuth layer is abstracted by the runtime and SDK so that you can focus on the problem and don't have to care about authentication and authorization.
Accessing classic endpoints with role-based permissions
As described above, the user's role-based permissions are enforced to access the classic endpoints with OAuth. For app developers, every endpoint has dedicated requirements regarding what permissions the user needs to access via the app. For example, the following list gives the required information to get the auto-update configuration for an ActiveGate:
- Method: activeGatesAutoUpdateConfigurationClient.getAutoUpdateConfigById()
- Description: Gets the configuration of auto-update for the specified ActiveGate
- OAuth scope for manifest: environment-api:activegates:read
- Required user permission: environment:roles:manage-settings
- Management zone permission: No
For this method, the user needs to be able to manage settings for the environment. All users with this permission will be able to interact with the service and, therefore, can use the app. You can find the details of every method in Classic Environment V2 reference.
Auditing of REST API calls
With the introduction of AppEngine and Grail, we can now monitor the full API spectrum and provide detailed API access logs as part of our audit logs on Grail. Since the classic environment service is exposed via AppEngine, you also get the benefit of API logs for this service.