Settings API - Service detection rules for External Web Requests schema table
Service detection rules for External Web Requests (builtin:service-detection.external-web-request)
Rules are evaluated from top to bottom, and the first matching rule applies. Rule conditions are evaluated before Service Id Contributors are applied. Note that conditions do not modify attributes of requests. If conditions match, then Service Id Contributors are applied. All of the Contributors except for the port are always applied. You can exclude the port contribution by disabling the switch. You can enable the transformation of other Service Id Contributors values to manage which Services are created.
More extensive information on Service detection rules can be found here.
Schema ID | Schema groups | Scope |
---|---|---|
builtin:service-detection.external-web-request |
| environment |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:service-detection.external-web-request |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:service-detection.external-web-request | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:service-detection.external-web-request |
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 |
---|---|---|---|
Enabledenabled | boolean | - | required |
Rule namename | text | - | required |
Descriptiondescription | text | - | optional |
Management zonesmanagementZones | set | Define a management zone of the process group for which this service detection rule should be created. Note: in case of external requests/services the PG might not always be known. See here | required |
Service identifier contributorsidContributors | idContributorsType | Contributors to the Service Identifier calculation. All of the Contributors except for the port are always applied. You can exclude the port contribution by disabling the switch. | required |
Conditionsconditions | condition[] | A list of conditions necessary for the rule to take effect. If multiple conditions are specified, they must all match a Request for the rule to apply. If there is no condition at all, the rule is always applied. Conditions are evaluated against attributes, but do not modify them. | required |
The idContributorsType
object
Property | Type | Description | Required |
---|---|---|---|
Application identifierapplicationId | serviceIdContributor | - | required |
URL context rootcontextRoot | contextIdContributor | - | required |
Public domain namepublicDomainName | publicDomainIdContributor | - | required |
PortportForServiceId | boolean | Let the port contribute to the Service Id | required |
The condition
object
Property | Type | Description | Required |
---|---|---|---|
Take the value of this attributeattribute | text | - | required |
Apply this operationcompareOperationType | text | - | required |
ValuestextValues | set | If multiple values are specified, at least one of them must match for the condition to match | required |
ValuestagValues | set | If multiple values are specified, at least one of them must match for the condition to match | required |
ValueintValue | integer | - | required |
ValuesintValues | set | - | required |
FromipRangeFrom | text | - | required |
ToipRangeTo | text | - | required |
Technologyframework | Set<frameworkType> |
| required |
Ignore caseignoreCase | boolean | Ignore case sensitivity for texts. | required |
The serviceIdContributor
object
Property | Type | Description | Required |
---|---|---|---|
Transform this value before letting it contribute to the Service IdenableIdContributor | boolean | - | required |
serviceIdContributor | transformationSet | - | required |
The contextIdContributor
object
Property | Type | Description | Required |
---|---|---|---|
Transform this value before letting it contribute to the Service IdenableIdContributor | boolean | - | required |
serviceIdContributor | contextRoot | - | required |
The publicDomainIdContributor
object
Property | Type | Description | Required |
---|---|---|---|
Transform this value before letting it contribute to the Service IdenableIdContributor | boolean | - | required |
serviceIdContributor | publicDomainTransformationSet | - | required |
The transformationSet
object
Property | Type | Description | Required |
---|---|---|---|
Contribution typecontributionType | enum | Defines whether the original value should be used or if a transformation set should be used to override a value or transform it.
| required |
Value overridevalueOverride | valueOverride | The value to be used instead of the detected value. | required |
Transformationstransformations | transformation[] | Choose how to transform a value before it contributes to the Service Id. Note that 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 overview page under Properties and tags. | required |
The contextRoot
object
Property | Type | Description | Required |
---|---|---|---|
Contribution typecontributionType | enum | Defines whether the original value should be used or if a transformation set should be used to override a value or transform it.
| required |
Value overridevalueOverride | valueOverride | The value to be used instead of the detected value. | required |
Segments to copy from URL pathsegmentCount | integer | The number of segments of the URL to be kept. The URL is divided by slashes (/), the indexing starts with 1 at context root. For example, if you specify 2 for the | required |
Transformationstransformations | reducedTransformation[] | Choose how to transform a value before it contributes to the Service Id. Note that 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 overview page under Properties and tags. | required |
The publicDomainTransformationSet
object
Property | Type | Description | Required |
---|---|---|---|
Contribution typecontributionType | enum | Defines whether the original value should be used or if a transformation set should be used to override a value or transform it.
| required |
Value overridevalueOverride | valueOverride | The value to be used instead of the detected value. | required |
Copy from host namecopyFromHostName | boolean | Use the detected host name instead of the request's domain name. | required |
Transformationstransformations | transformation[] | Choose how to transform a value before it contributes to the Service Id. Note that 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 overview page under Properties and tags. | required |
The valueOverride
object
Property | Type | Description | Required |
---|---|---|---|
Valuevalue | text | - | required |
The transformation
object
Property | Type | Description | Required |
---|---|---|---|
Transformation typetransformationType | enum | Defines what kind of transformation will be applied on the original value.
| required |
prefixprefix | text | - | optional |
suffixsuffix | text | - | optional |
replacementreplacementValue | text | - | optional |
split bysplitDelimiter | text | - | optional |
select indexselectIndex | integer | - | required |
min digit countminDigitCount | integer | - | required |
include hexadecimal numbersincludeHexNumbers | boolean | - | required |
segment countsegmentCount | integer | How many segments should be taken. | required |
take from endtakeFromEnd | boolean | - | required |
The reducedTransformation
object
Property | Type | Description | Required |
---|---|---|---|
Transformation TypetransformationType | enum | Defines what kind of transformation will be applied on the original value.
| required |
prefixprefix | text | - | optional |
suffixsuffix | text | - | optional |
replacementreplacementValue | text | - | optional |
min digit countminDigitCount | integer | - | required |
include hexadecimal numbersincludeHexNumbers | boolean | - | required |