OneAgent monitoring configuration API - PUT configuration

Updates the monitoring configuration of OneAgent on the specified host.

The request consumes an application/json payload.

Preview

This request is currently in Preview and is subject to change. Changes may not be compatible with your current configuration.

PUT	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/hosts/{id}/monitoring SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id}/monitoring

Authentication

To execute this request, you need the Write configuration permission assigned to your API token. To learn how to obtain and use it, see Authentication.

Parameters

Parameter	Type	Description	In	Required
id	string	The Dynatrace entity ID of the required host.	path	required
body	MonitoringConfig	The JSON body of the request. Contains OneAgent monitoring parameters.	body	optional

Request parameters JSON model

The MonitoringConfig object

Monitoring configuration of OneAgent.

Element	Type	Description	Required
metadata	ConfigurationMetadata		optional
id	string	The Dynatrace entity ID of the host where OneAgent is deployed.	optional
monitoringEnabled	boolean	The monitoring is enabled (`true`) or disabled (`false`).	required
monitoringMode	string	The monitoring mode for the host: full stack or infrastructure only. The monitoringMode element can hold these values.	required

The ConfigurationMetadata object

Metadata useful for debugging

Element	Type	Description	Required
clusterVersion	string	Dynatrace server version.	optional
configurationVersions	integer[]	A Sorted list of the version numbers of the configuration.	optional

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.

      
  {
  "metadata": {
    "clusterVersion": "1.192.1",
    "configurationVersions": [
      "integer"
    ]
  },
  "id": "HOST-0123456789ABCDE",
  "monitoringEnabled": true,
  "monitoringMode": "FULL_STACK"
}

Possible values

Possible values for the monitoringMode element in the MonitoringConfig object:

CLOUD_INFRASTRUCTURE
FULL_STACK

Response format

A successful request doesn't return any content.

Response codes

Code	Description
204	Success. The configuration has been updated. Response doesn't have a body.
400	Failed. The input is invalid

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

Preview

This request is currently in Preview and is subject to change. Changes may not be compatible with your current configuration.

POST	Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/hosts/{id}/monitoring/validator SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/hosts/{id}/monitoring/validator

Authentication

To execute this request, you need the Write configuration permission assigned to your API token. To learn how to obtain and use it, see Authentication.

Response codes

Code	Description
204	Validated. The submitted configuration is valid. Response doesn't have a body.
400	Failed. The input is invalid