• Home
  • API
  • Environment
  • Settings
  • Schemas
  • Monitoring mode

Settings API - Monitoring mode schema table

Monitoring Mode (builtin:host.monitoring.mode)

OneAgent monitoring mode can only be switched while the agent is connected.

Schema IDSchema groupsScope
builtin:host.monitoring.mode
  • group:host-monitoring
HOST - Host
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:host.monitoring.mode
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:host.monitoring.mode
Environment ActiveGatehttps://{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

PropertyLabelTypeDescriptionRequired
monitoringModeMonitoring modeenum

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