• Home
  • Dynatrace API
  • Configuration
  • RUM
  • Applications detection
  • PUT host detection headers

Applications detection rules API - PUT host detection headers

Updates the list of the host detection headers.

The request consumes an application/json payload.

PUTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/applicationDetectionRules/hostDetection
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/applicationDetectionRules/hostDetection
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/applicationDetectionRules/hostDetection

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
bodyApplicationDetectionRulesHostDetectionSettings

The JSON body of the request. Contains the configuration of host detection headers.

bodyoptional

Request body objects

The ApplicationDetectionRulesHostDetectionSettings object

Configuration of host detection headers.

ElementTypeDescriptionRequired
metadataConfigurationMetadata

Metadata useful for debugging

optional
hostDetectionHeadersstring[]

An ordered list of host detection headers.

Headers are evaluated from top to bottom; the first matching header applies.

required

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescriptionRequired
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

optional
clusterVersionstring

Dynatrace version.

optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

json
{ "metadata": { "configurationVersions": [ 4, 2 ], "clusterVersion": "Mock version" }, "hostDetectionHeaders": [ "X-Host", "X-Forwarded-Host" ] }

Response

Response codes

CodeTypeDescription
204

Success. The configuration has been updated. Response doesn't have a body.

400ErrorEnvelope

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.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/applicationDetectionRules/hostDetection/validator
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/applicationDetectionRules/hostDetection/validator
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/applicationDetectionRules/hostDetection/validator

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

CodeTypeDescription
204

Success. The submitted configuration is valid. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.

Related topics
  • Real User Monitoring

    Learn about Real User Monitoring, key performance metrics, mobile app monitoring, and more.

  • Define applications for Real User Monitoring

    Learn how to define your applications following the suggested, manual, application detection rules, or browser extension approach.