Settings API - Exclude IP addresses from monitoring schema table

  • Published Dec 05, 2023

Exclude IP addresses from monitoring (builtin:rum.web.ipaddress-exclusion)

Enable the switch below if the IP addresses are to be included. Disable the switch if they are to be excluded.

Schema IDSchema groupsScope
builtin:rum.web.ipaddress-exclusion
  • group:capturing
  • group:capturing.exclusions
APPLICATION - Web application
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.web.ipaddress-exclusion
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:rum.web.ipaddress-exclusion
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.web.ipaddress-exclusion

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
IP addresses exclusion list
ipExclusionList		IpAddressExclusionRule[]

Examples:

  • 84.112.10.5
  • fe80::10a1:c6b2:5f68:785d
Required
These are the only IP addresses that should be monitored
ipAddressExclusionInclude		boolean-Required
The IpAddressExclusionRule object
PropertyTypeDescriptionRequired
Single IP or IP range start address
ip		text-Required
IP range end
ipTo		text-Optional