Settings API - Rule Based Relationship Worker Settings schema table

  • Published Sep 25, 2025

Rule Based Relationship Worker Settings (builtin:monitoredentities.rule.based.relationship.worker)

Configure rule based relationship worker settings.

The rule based relationship worker runs every configured time period and establishes configured relationships between entities based on their properties

Schema IDSchema groupsScope
builtin:monitoredentities.rule.based.relationship.worker-
environment
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:monitoredentities.rule.based.relationship.worker
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:monitoredentities.rule.based.relationship.worker
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:monitoredentities.rule.based.relationship.worker

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
Interval time
runInterval		integer

Time in between worker runs (in minutes)

required
Timeframe
timeframe		integer

Timeframe (in minutes) to look back to. Only entities which are last seen in this timeframe are considered

required
Result limit
resultLimit		integer

Query limit for the number of entities which are considered

required
Partition size
partitionSize		integer

Size of the partition, which defines how many entities are handled at once

required
Maximum new relationships per entity and rule
maxNewRelationshipsPerRule		integer

Maximum number of new relationships created for one entity per rule

required