• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Service detection rules for external web services

Settings API - Service detection rules for External Web Services schema table

Service detection rules for External Web Services (builtin:service-detection.external-web-service)

Rules are evaluated from top to bottom, and the first matching rule applies. Rule conditions are evaluated before Service Id Contributors are applied. Conditions do not modify attributes of requests. If conditions match, then Service Id Contributors are applied. All of the Contributors always get applied. But it is possible to influence the creation of Services by choosing how they get transformed.
More extensive information on Service detection rules can be found here.

Schema IDSchema groupsScope
builtin:service-detection.external-web-service
  • group:service-detection
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:service-detection.external-web-service
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:service-detection.external-web-service
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:service-detection.external-web-service

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
enabledEnabledboolean-required
nameRule nametext-required
descriptionDescriptiontext-optional
managementZonesManagement zonesset

Define a management zone filter for this service detection rule.

required
idContributorsService identifier contributorsidContributorsType

Contributors to the Service Identifier calculation. URL path is always applied as an Id Contributor. It is possible to exclude Port from contributing by toggling the switch off.

required
conditionsConditionslist

A list of conditions necessary for the rule to take effect. If multiple conditions are specified, they all must match a Request for the rule to apply. Conditions evaluate against attributes, but do not modify them.

required

Request body objects

The condition object
PropertyLabelTypeDescriptionRequired
attributeTake the value of this attributetext-required
compareOperationTypeApply this operationtext-required
textValuesValuesset

If multiple values are specified, at least one of them must match for the condition to match

required
tagValuesValuesset

If multiple values are specified, at least one of them must match for the condition to match

required
intValueValueinteger-required
intValuesValuesset-required
ipRangeFromFromtext-required
ipRangeToTotext-required
frameworkTechnologyset-required
ignoreCaseIgnore caseboolean

Ignore case sensitivity for texts.

required
The transformation object
PropertyLabelTypeDescriptionRequired
transformationTypeTransformation typeenum

Defines what kind of transformation will be applied on the original value.

required
prefixprefixtext-optional
suffixsuffixtext-optional
replacementValuereplacementtext-optional
splitDelimitersplit bytext-optional
selectIndexselect indexinteger-required
minDigitCountmin digit countinteger-required
includeHexNumbersinclude hexadecimal numbersboolean-required
segmentCountsegment countinteger

How many segments should be taken.

required
takeFromEndtake from endboolean-required
The valueOverride object
PropertyLabelTypeDescriptionRequired
valueValuetext-required
The transformationSet object
PropertyLabelTypeDescriptionRequired
contributionTypeContribution typeenum

Defines whether the original value should be used or if a transformation set should be used to override a value or transform it.

required
valueOverrideValue overridevalueOverride

The value to be used instead of the detected value.

required
transformationsTransformationslist

Choose how the value will be transformed before contributing to the Service Id. All of the Transformations are always applied. Transformations are applied in the order they are specified, and the output of the previous transformation is the input for the next one. The resulting value contributes to the Service Id and can be found on the Service screen under Properties and tags.

required
The serviceIdContributor object
PropertyLabelTypeDescriptionRequired
enableIdContributorTransform this value before letting it contribute to the Service Idboolean-required
serviceIdContributor-transformationSet-required
The idContributorsType object
PropertyLabelTypeDescriptionRequired
detectAsWebRequestServiceDetect as web request serviceboolean

Detect the matching requests as web request services instead of web services.

This prevents detecting of matching requests as opaque web services. An opaque web request service is created instead. If you need to further modify the resulting web request service, you need to create a separate Opaque/external web request rule.

required
urlPathURL pathserviceIdContributor-required
portForServiceIdPortboolean

Let the Port contribute to the Service Id

required