Settings API - API detection rules schema table

API detection rules (`builtin:apis.detection-rules`)

Modern applications use a lot of different frameworks, so stacktraces in method hotspots and exceptions can become quite long. APIs allow you to spot a component and the respective ownership that is responsible for a hotspot or degradation faster.

API detection rules look at a stacktrace frame and classify it based on classes (Java, .NET and PHP) or files (Node.js, PHP and GO) depending on the technology. The rules are executed in order and the first match decides the API. Marking APIs as third party will allow you to focus on non-third party APIs.

Schema ID	Schema groups	Scope
`builtin:apis.detection-rules`	`group:service-monitoring`	`environment`

Retrieve schema via Settings API

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:apis.detection-rules`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:apis.detection-rules`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:apis.detection-rules`

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	Label	Type	Description	Required
apiName	API name	text	-	required
apiColor	Color	text	This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.	required
technology	Technology	enum	Restrict this rule to a specific technology.	optional
thirdPartyApi	This API defines a third party library	boolean	-	required
conditions	List of conditions	set	-	required

Request body objects

The `apiRule` object

Property	Label	Type	Description	Required
base	Base	enum	-	required
matcher	Matcher	enum	-	required
pattern	Pattern	text	-	required