Service detection API - POST an opaque web service rule

Creates a new service detection rule for opaque and external web services.

The request consumes and produces an application/json payload.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/service/detectionRules/OPAQUE_AND_EXTERNAL_WEB_SERVICE
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/service/detectionRules/OPAQUE_AND_EXTERNAL_WEB_SERVICE

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

Refer to JSON models to find all JSON models that depend on the type of the model.

Parameter
Type
Description
In
Required
position
string

The position of the new rule:

  • APPEND: at the end of the rule list.
  • PREPEND: on top of the rule list.
  • APPEND
  • PREPEND
query
optional
body

The JSON body of the request containing parameters of the new service detection rule.

You must not specify the ID of the rule!

The order field is ignored in this request. To enforce a particular order use the PUT /service/detectionRules/OPAQUE_AND_EXTERNAL_WEB_SERVICE/reorder request.

body
optional

Request body objects

The OpaqueAndExternalWebServiceRule object

The service detection rule of the OPAQUE_AND_EXTERNAL_WEB_SERVICE type

Element
Type
Description
Required
conditions

A list of conditions of the rule.

If several conditions are specified, the AND logic applies.

optional
description
string

A short description of the rule.

optional
detectAsWebRequestService
boolean

Detect the matching requests as web services (false) or web request services (true).

Setting this field to true 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 rule of the OPAQUE_AND_EXTERNAL_WEB_REQUEST type.

Default is false, detecting matching requests as opaque web services.

optional
enabled
boolean

The rule is enabled(true) or disabled (false).

required
id
string

The ID of the service detection rule.

optional
managementZones
string[]

The management zone (specified by the ID) of the process group for which this service detection rule should be created.

You can specify only 1 management zone here.

optional
metadata

Metadata useful for debugging

optional
name
string

The name of the rule.

required
order
string

The order of the rule in the rules list.

The rules are evaluated from top to bottom. The first matching rule applies.

optional
port

The contribution to the service ID calculation from the port, where the web request has been detected.

optional
type
string

The type of the service detection rule.

required
urlPath

The contribution from the URL, where the web request has been detected, into service ID calculation.

You have two mutually exclusive options:

  • Override the detected value with a specified static value. Specify the new value in the valueOverride field.
  • Dynamically transform the detected value. Specify the transformation parameters in the transformations field.
optional

The ConditionsOpaqueAndExternalWebServiceAttributeTypeDto object

A condition of the service detection rule.

Element
Type
Description
Required
attributeType
string

The type of the attribute to be checked.

  • ENDPOINT
  • IP
  • OPERATION_NAME
  • PG_TAG
  • URL_PATH
  • URL_PORT
required
compareOperations

A list of conditions for the rule.

If several conditions are specified, the AND logic applies.

optional

The CompareOperation object

The condition of the rule.

The actual set of fields depends on the type of the condition. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element
Type
Description
Required
type
string

Defines the actual set of fields depending on the value. See one of the following objects:

  • EQUALS -> EqualsCompareOperation
  • STRING_CONTAINS -> StringContainsCompareOperation
  • STARTS_WITH -> StartsWithCompareOperation
  • ENDS_WITH -> EndsWithCompareOperation
  • EXISTS -> ExistsCompareOperation
  • IP_IN_RANGE -> IpInRangeCompareOperation
  • LESS_THAN -> LessThanCompareOperation
  • GREATER_THAN -> GreaterThanCompareOperation
  • INT_EQUALS -> IntEqualsCompareOperation
  • STRING_EQUALS -> StringEqualsCompareOperation
  • TAG -> TagCompareOperation
  • ENDS_WITH
  • EQUALS
  • EXISTS
  • GREATER_THAN
  • INT_EQUALS
  • IP_IN_RANGE
  • LESS_THAN
  • STARTS_WITH
  • STRING_CONTAINS
  • STRING_EQUALS
  • TAG
required

The ConfigurationMetadata object

Metadata useful for debugging

Element
Type
Description
Required
clusterVersion
string

Dynatrace version.

optional
configurationVersions
integer[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersions
string[]

A sorted list of version numbers of the configuration.

optional

The Port object

The contribution to the service ID calculation from the port, where the web request has been detected.

Element
Type
Description
Required
doNotUseForServiceId
boolean

The port is used (false) or isn't used (true) in the service ID calculation.

optional

The UrlPath object

The contribution from the URL, where the web request has been detected, into service ID calculation.

You have two mutually exclusive options:

  • Override the detected value with a specified static value. Specify the new value in the valueOverride field.
  • Dynamically transform the detected value. Specify the transformation parameters in the transformations field.
Element
Type
Description
Required
transformations

Transformations to be applied to the detected value.

optional
valueOverride
string

The value to be used instead of the detected value.

optional

The TransformationBase object

Configuration of transformation of the detected value.

If several transformations are specified, they are handled sequentially from top to bottom. Each transformation is applied to the result of the preceding transformation. For example, the second transformation is applied to the result of the first transformation.

The actual set of fields depends on the type of the transformation. Find the list of actual objects in the description of the type field or see Service detection API - JSON models.

Element
Type
Description
Required
type
string

Defines the actual set of fields depending on the value. See one of the following objects:

  • BEFORE -> BeforeTransformation
  • AFTER -> AfterTransformation
  • BETWEEN -> BetweenTransformation
  • REPLACE_BETWEEN -> ReplaceBetweenTransformation
  • REMOVE_NUMBERS -> RemoveNumbersTransformation
  • REMOVE_CREDIT_CARDS -> RemoveCreditCardNumbersTransformation
  • REMOVE_IBANS -> RemoveIBANsTransformation
  • REMOVE_IPS -> RemoveIPsTransformation
  • SPLIT_SELECT -> SplitSelectTransformation
  • TAKE_SEGMENTS -> TakeSegmentsTransformation
  • AFTER
  • BEFORE
  • BETWEEN
  • REMOVE_CREDIT_CARDS
  • REMOVE_IBANS
  • REMOVE_IPS
  • REMOVE_NUMBERS
  • REPLACE_BETWEEN
  • SPLIT_SELECT
  • TAKE_SEGMENTS
required

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.

{
  "conditions": [
    {
      "attributeType": "URL_PATH",
      "compareOperations": [
        {
          "ignoreCase": "false",
          "invert": "false",
          "type": "STRING_CONTAINS",
          "values": [
            "value1",
            "value2"
          ]
        }
      ]
    }
  ],
  "description": "REST API example",
  "detectAsWebRequestService": false,
  "enabled": true,
  "managementZones": [
    "zone 1"
  ],
  "name": "My sample rule",
  "port": {
    "doNotUseForServiceId": "true"
  },
  "type": "OPAQUE_AND_EXTERNAL_WEB_SERVICE",
  "urlPath": {
    "valueOverride": "abc"
  }
}

Response

Response codes

Code
Type
Description
201

Success. The new service detection rule has been created. The response contains short representation of the rule, including the ID.

400

Failed. The input is invalid.

Response body objects

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element
Type
Description
description
string

A short description of the Dynatrace entity.

id
string

The ID of the Dynatrace entity.

name
string

The name of the Dynatrace entity.

Response body JSON model

{
  "description": "Dynatrace entity for the REST API example",
  "id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
  "name": "Dynatrace entity"
}

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.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/service/detectionRules/OPAQUE_AND_EXTERNAL_WEB_SERVICE/validator
Environment ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/config/v1/service/detectionRules/OPAQUE_AND_EXTERNAL_WEB_SERVICE/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

Code
Type
Description
204
-

Validated. The service detection rule is valid. Response doesn't have a body.

400

Failed. The input is invalid.

Related topics