custom-rule

Contains settings for a custom rule.

API DiscoveryAPI SecurityCloud SecurityPosture ManagementRuntime ProtectionThreat Protection

Properties

Name Type Description
conditions array Contains the details about the condition that triggers the custom rule.
description string The custom rule description.
effectiveTimePeriod object The time period during which the custom rule is active.
id integer Uniquely identifies the rule.
inspectRequest boolean Whether to inspect the HTTP request for unstructured custom rules.
inspectResponse boolean Whether to inspect the HTTP response for unstructured custom rules.
loggingOptions array The specific conditions to be logged.
metadata string The metadata you provided for unstructured custom rules.
name string The custom rule name.
operation string Specify `AND` logic to require all conditions, or `OR` logic to require at least one condition to match.
ruleActivated boolean Whether the rule is active in the configuration.
samplingRate integer The portion of traffic to sample, expressed as a percent.
stagingOnly boolean Whether to show traffic from only the staging network, or all traffic. The default setting is `false` and only shows in the response when `true`.
structured boolean Whether you created the rule with the structured custom rule builder or free-form XML. This needs to be `true`.
tag array The list of labels you assigned to the custom rule.
version integer The custom rule version.
View JSON Schema on GitHub