Settings API - Exclude network traffic schema table
Exclude network traffic (builtin:exclude.network.traffic)
OneAgent automatically detects and monitors all of your network traffic, but you can exclude traffic on specific network interfaces or hosts from monitoring.
Schema ID | Schema groups | Scope |
---|---|---|
builtin:exclude.network.traffic |
| HOST - Host |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:exclude.network.traffic |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:exclude.network.traffic | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:exclude.network.traffic |
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 | Type | Description | Required |
---|---|---|---|
Exclude NICexcludeNic | NicForm[] | Selecting a network interface, you will exclude all network traffic on that interface from being monitored. You can select from the list below what to not monitor, or input it manually using the "other one" option. | required |
Exclude IPexcludeIp | IpAddressForm[] | Providing a host IP address, you will exclude network traffic only in calculating connectivity (other metrics will still be calculated). | required |
The NicForm
object
Property | Type | Description | Required |
---|---|---|---|
Operating systemos | enum |
| required |
Network interfaceinterface | text | - | required |
The IpAddressForm
object
Property | Type | Description | Required |
---|---|---|---|
IP addressipAddress | text | - | required |