Settings API - Monitoring Mode schema table
Monitoring Mode (builtin:host.monitoring.mode)
OneAgent monitoring mode can only be switched while the agent is connected.
Note that for this schema only, the GET objects api will usually not return any objects as these settings are stored on the agents - please use the GET effective values api instead.
| Schema ID | Schema groups | Scope |
|---|---|---|
builtin:host.monitoring.mode |
| HOST - Host |
| GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:host.monitoring.mode |
| SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:host.monitoring.mode | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:host.monitoring.mode |
Authentication
To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.
Parameters
| Property | Type | Description | Required |
|---|---|---|---|
Monitoring modemonitoringMode | enum | Dynatrace OneAgent allows you to monitor every aspect of your environment, including all processes, services, and applications detected on your hosts. OneAgent monitoring modes give you flexibility to adjust which capabilities of OneAgent are enabled for your host. Each successive mode increases the enabled capabilities, but also increases license consumption. To learn more, visit Monitoring consumption. Monitoring mode will be applied to a process after its restart. The OneAgent's monitoring mode will automatically overwrite this setting whenever it is changed with oneagentctl or the OneAgent comes online.
| required |