Settings API - Security enrichment connections schema table

  • Published Mar 06, 2026

Security enrichment connections (builtin:security-enrichment.connections)

Create and manage connections for security enrichment integrations

Schema IDSchema groupsScope
builtin:security-enrichment.connections-
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:security-enrichment.connections
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:security-enrichment.connections
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:security-enrichment.connections

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

PropertyTypeDescriptionRequired
Connection name
name		text

Enter a unique connection name.

Required
Integration vendor name
vendor		text

A name to identify the vendor of the security enrichment integration.

Required
Connection endpoint URL
endpointUrl		text

The endpoint URL for the connection.

Required
Authentication Type
authenticationType		enum

Select the authentication type.

The element has these enums
  • CUSTOM
Optional
Authentication Secret
authenticationSecret		secret

Paste the authentication secret in this field.

Optional
HTTP Method
httpMethod		enum

The HTTP method to use for the connection.

The element has these enums
  • GET
  • PUT
  • POST
Required
Supported Observable Types
supportedObservableTypes		Set<ObservableType>

The types of observables supported by this connection for enrichment.

The element has these enums
  • ip-addr
Required
Query Parameters
queryParameters		Entry[]-Required
Request Body
body		text

The body of the HTTP request.

Optional
HTTP Headers
headers		Entry[]-Required
Custom Options
customOptions		Set<CustomOption>

The custom options available for this connection.

Required
Mapping DQL
mappingDql		text

The DQL script used for mapping the 3-rd party enrichment response to normalized fields in the mapped response.

Optional
The Entry object
PropertyTypeDescriptionRequired
key
key		text

key

Required
value
value		text

value

Optional
The CustomOption object
PropertyTypeDescriptionRequired
key
key		text

key

Required
The type of the custom option
type		enum

type

The element has these enums
  • text
  • number
  • boolean
Required
A brief description of the custom option
description		text

description

Optional
Required
required		boolean

Defines whether this CustomOption is required or not

Required