Test a rule
POST
https://api.datadoghq.com/api/v2/security_monitoring/rules/testhttps://api.us3.datadoghq.com/api/v2/security_monitoring/rules/testhttps://api.us5.datadoghq.com/api/v2/security_monitoring/rules/testhttps://api.datadoghq.eu/api/v2/security_monitoring/rules/testhttps://api.ap1.datadoghq.com/api/v2/security_monitoring/rules/testhttps://api.ap2.datadoghq.com/api/v2/security_monitoring/rules/testhttps://api.uk1.datadoghq.com/api/v2/security_monitoring/rules/testhttps://api.ddog-gov.com/api/v2/security_monitoring/rules/testhttps://api.us2.ddog-gov.com/api/v2/security_monitoring/rules/testOverview
Test a rule.
OAuth apps require the security_monitoring_rules_write authorization scope to access this endpoint.
Request
Body Data (required)
Field
Type
Description
rule<oneOf>
Test a rule.
<type=log_detection>object
The payload of a rule to test
calculatedFields[object]
Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
expression [required]string
Expression.
name [required]string
Field name.
cases [required][object]
Cases for generating signals.
actions[object]
Action to perform for each rule case.
optionsobject
Options for the rule action
durationint64
Duration of the action in seconds. 0 indicates no expiration.
flaggedIPTypeenum
Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses.
Allowed enum values:
SUSPICIOUS, FLAGGEDuserBehaviorNamestring
Used with the case action of type 'user_behavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.
typeenum
The action type.
Allowed enum values:
block_ip, block_user, user_behavior, flag_ipconditionstring
A case contains logical operations (>,>=, &&, ||) to determine if a signal should be generated
based on the event counts in the previously defined queries.
namestring
Name of the case.
notifications[string]
Notification targets.
status [required]enum
Severity of the Security Signal.
Allowed enum values:
info, low, medium, high, criticalfilters[object]
Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
actionenum
The type of filtering action.
Allowed enum values:
require, suppressquerystring
Query for selecting logs to apply the filtering action.
groupSignalsBy[string]
Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
hasExtendedTitleboolean
Whether the notifications include the triggering group-by values in their title.
isEnabled [required]boolean
Whether the rule is enabled.
message [required]string
Message for generated signals.
name [required]string
The name of the rule.
options [required]object
Options.
anomalyDetectionOptionsobject
Options on anomaly detection method.
bucketDurationenum
Duration in seconds of the time buckets used to aggregate events matched by the rule. Must be greater than or equal to 300.
Allowed enum values:
300, 600, 900, 1800, 3600, 10800detectionToleranceenum
An optional parameter that sets how permissive anomaly detection is. Higher values require higher deviations before triggering a signal.
Allowed enum values:
1, 2, 3, 4, 5instantaneousBaselineboolean
When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.
learningDurationenum
Learning duration in hours. Anomaly detection waits for at least this amount of historical data before it starts evaluating.
Allowed enum values:
1, 6, 12, 24, 48, 168, 336learningPeriodBaselineint64
An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.
complianceRuleOptionsobject
Options for cloud_configuration rules.
Fields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.
complexRuleboolean
Whether the rule is a complex one.
Must be set to true if regoRule.resourceTypes contains more than one item. Defaults to false.
regoRuleobject
Rule details.
policy [required]string
The policy written in rego, see: https://www.openpolicyagent.org/docs/latest/policy-language/
resourceTypes [required][string]
List of resource types that will be evaluated upon. Must have at least one element.
resourceTypestring
Main resource type to be checked by the rule. It should be specified again in regoRule.resourceTypes.
decreaseCriticalityBasedOnEnvboolean
If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.
The severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO.
The decrement is applied when the environment tag of the signal starts with staging, test or dev.
detectionMethodenum
The detection method.
Allowed enum values:
threshold, new_value, anomaly_detection, impossible_travel, hardcoded, third_party, anomaly_threshold, sequence_detectionevaluationWindowenum
A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. For third party detection method, this field is not used.
Allowed enum values:
0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600Show 2 more
43200, 86400hardcodedEvaluatorTypeenum
Hardcoded evaluator type.
Allowed enum values:
log4shellimpossibleTravelOptionsobject
Options on impossible travel detection method.
baselineUserLocationsboolean
If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular access locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.
baselineUserLocationsDurationint32
The duration in days during which Datadog learns the user's regular access locations. After this period, signals are generated for accesses from unknown locations.
keepAliveenum
Once a signal is generated, the signal will remain "open" if a case is matched at least once within this keep alive window. For third party detection method, this field is not used.
Allowed enum values:
0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600Show 2 more
43200, 86400maxSignalDurationenum
A signal will "close" regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp.
Allowed enum values:
0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600Show 2 more
43200, 86400newValueOptionsobject
Options on new value detection method.
forgetAfterint32
The duration in days after which a learned value is forgotten.
instantaneousBaselineboolean
When set to true, Datadog uses previous values that fall within the defined learning window to construct the baseline, enabling the system to establish an accurate baseline more rapidly rather than relying solely on gradual learning over time.
learningDurationint32
The duration in days during which values are learned, and after which signals will be generated for values that weren't learned. If set to 0, a signal will be generated for all new values after the first value is learned.
0learningMethodenum
The learning method used to determine when signals should be generated for values that weren't learned.
durationAllowed enum values:
duration, thresholdlearningThresholdenum
A number of occurrences after which signals will be generated for values that weren't learned.
0Allowed enum values:
0, 1sequenceDetectionOptionsobject
Options on sequence detection method.
stepTransitions[object]
Transitions defining the allowed order of steps and their evaluation windows.
childstring
Name of the child step.
evaluationWindowenum
A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. For third party detection method, this field is not used.
Allowed enum values:
0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600Show 2 more
43200, 86400parentstring
Name of the parent step.
steps[object]
Steps that define the conditions to be matched in sequence.
conditionstring
Condition referencing rule queries (e.g., a > 0).
evaluationWindowenum
A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. For third party detection method, this field is not used.
Allowed enum values:
0, 60, 300, 600, 900, 1800, 3600, 7200, 10800, 21600Show 2 more
43200, 86400namestring
Unique name identifying the step.
thirdPartyRuleOptionsobject
Options on third party detection method.
defaultNotifications[string]
Notification targets for the logs that do not correspond to any of the cases.
defaultStatusenum
Severity of the Security Signal.
Allowed enum values:
info, low, medium, high, criticalrootQueries[object]
Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.
groupByFields[string]
Fields to group by.
querystring
Query to run on logs.
signalTitleTemplatestring
A template for the signal title; if omitted, the title is generated based on the case name.
queries [required][object]
Queries for selecting logs which are part of the rule.
aggregationenum
The aggregation type.
Allowed enum values:
count, cardinality, sum, max, new_value, geo_data, event_count, nonecustomQueryExtensionstring
Query extension to append to the logs query.
dataSourceenum
Source of events, either logs, audit trail, security signals, or Datadog events. app_sec_spans is deprecated in favor of spans.
logsAllowed enum values:
logs, audit, app_sec_spans, spans, security_runtime, network, events, security_signalsdatasetIds[string]
IDs of the datasets queried by the rule. Only used when queryLanguage is sql.
datasetVersionsobject
Version of each dataset used by the rule, keyed by dataset ID. Only used when queryLanguage is sql.
<any-key>int64
Dataset version.
distinctFields[string]
Field for which the cardinality is measured. Sent as an array.
groupByFields[string]
Fields to group by.
hasOptionalGroupByFieldsboolean
When false, events without a group-by value are ignored by the rule. When true, events with missing group-by fields are processed with N/A, replacing the missing values.
falseindexstring
This field is currently unstable and might be removed in a minor version upgrade.
The index to run the query on, if the dataSource is logs. Only used for scheduled rules - in other words, when the schedulingOptions field is present in the rule payload.
indexes[string]
List of indexes to query when the dataSource is logs. Only used for scheduled rules, such as when the schedulingOptions field is present in the rule payload.
metricstring
DEPRECATED (Deprecated) The target field to aggregate over when using the sum or max
aggregations. metrics field should be used instead.
metrics[string]
Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.
namestring
Name of the query.
querystring
Query to run on logs.
queryLanguagestring
Language of the query. Use sql for SQL-based rules over datasets. Defaults to event_query.
referenceTables[object]
Reference tables for the rule.
checkPresenceboolean
Whether to include or exclude the matched values.
columnNamestring
The name of the column in the reference table.
logFieldPathstring
The field in the log to match against the reference table.
ruleQueryNamestring
The name of the query to apply the reference table to.
tableNamestring
The name of the reference table.
schedulingOptionsobject
Options for scheduled rules. When this field is present, the rule runs based on the schedule. When absent, it runs real-time on ingested logs.
startstring
Start date for the schedule, in ISO 8601 format without timezone.
tags[string]
Tags for generated signals.
thirdPartyCases[object]
Cases for generating signals from third-party rules. Only available for third-party rules.
namestring
Name of the case.
notifications[string]
Notification targets for each case.
querystring
A query to map a third party event to this case.
status [required]enum
Severity of the Security Signal.
Allowed enum values:
info, low, medium, high, criticaltypeenum
The rule type.
Allowed enum values:
log_detectionruleQueryPayloads[object]
Data payloads used to test rules query with the expected result.
expectedResultboolean
Expected result of the test.
indexint64
Index of the query under test.
payloadobject
Payload used to test the rule query.
ddsourcestring
Source of the payload.
ddtagsstring
Tags associated with your data.
hostnamestring
The name of the originating host of the log.
messagestring
The message of the payload.
servicestring
The name of the application or service generating the data.
{
"rule": {
"cases": [
{
"name": "",
"status": "info",
"notifications": [],
"condition": "a > 0"
}
],
"hasExtendedTitle": true,
"isEnabled": true,
"message": "My security monitoring rule message.",
"name": "My security monitoring rule.",
"options": {
"decreaseCriticalityBasedOnEnv": false,
"detectionMethod": "threshold",
"evaluationWindow": 0,
"keepAlive": 0,
"maxSignalDuration": 0
},
"queries": [
{
"query": "source:source_here",
"groupByFields": [
"@userIdentity.assumed_role"
],
"distinctFields": [],
"aggregation": "count",
"name": ""
}
],
"tags": [
"env:prod",
"team:security"
],
"type": "log_detection"
},
"ruleQueryPayloads": [
{
"expectedResult": true,
"index": 0,
"payload": {
"ddsource": "source_here",
"ddtags": "env:staging,version:5.1",
"hostname": "i-012345678",
"message": "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World",
"service": "payment",
"userIdentity": {
"assumed_role": "fake assumed_role"
}
}
}
]
}Response
OK
Result of the test of the rule queries.
Field
Type
Description
results[boolean]
Assert results are returned in the same order as the rule query payloads. For each payload, it returns True if the result matched the expected result, False otherwise.
{
"results": []
}Bad Request
API error response.
Field
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Concurrent Modification
API error response.
Field
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Not Authorized
API error response.
Field
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Not Found
API error response.
Field
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
Field
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Code Example
Test a rule returns "OK" response
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/rules/test" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"rule": {
"cases": [
{
"name": "",
"status": "info",
"notifications": [],
"condition": "a > 0"
}
],
"hasExtendedTitle": true,
"isEnabled": true,
"message": "My security monitoring rule message.",
"name": "My security monitoring rule.",
"options": {
"decreaseCriticalityBasedOnEnv": false,
"detectionMethod": "threshold",
"evaluationWindow": 0,
"keepAlive": 0,
"maxSignalDuration": 0
},
"queries": [
{
"query": "source:source_here",
"groupByFields": [
"@userIdentity.assumed_role"
],
"distinctFields": [],
"aggregation": "count",
"name": ""
}
],
"tags": [
"env:prod",
"team:security"
],
"type": "log_detection"
},
"ruleQueryPayloads": [
{
"expectedResult": true,
"index": 0,
"payload": {
"ddsource": "source_here",
"ddtags": "env:staging,version:5.1",
"hostname": "i-012345678",
"message": "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World",
"service": "payment",
"userIdentity": {
"assumed_role": "fake assumed_role"
}
}
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/rules/test" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"rule": {
"cases": [
{
"name": "",
"status": "info",
"notifications": [],
"condition": "a > 0"
}
],
"hasExtendedTitle": true,
"isEnabled": true,
"message": "My security monitoring rule message.",
"name": "My security monitoring rule.",
"options": {
"decreaseCriticalityBasedOnEnv": false,
"detectionMethod": "threshold",
"evaluationWindow": 0,
"keepAlive": 0,
"maxSignalDuration": 0
},
"queries": [
{
"query": "source:source_here",
"groupByFields": [
"@userIdentity.assumed_role"
],
"distinctFields": [],
"aggregation": "count",
"name": ""
}
],
"tags": [
"env:prod",
"team:security"
],
"type": "log_detection"
},
"ruleQueryPayloads": [
{
"expectedResult": true,
"index": 0,
"payload": {
"ddsource": "source_here",
"ddtags": "env:staging,version:5.1",
"hostname": "i-012345678",
"message": "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World",
"service": "payment",
"userIdentity": {
"assumed_role": "fake assumed_role"
}
}
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/rules/test" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"rule": {
"cases": [
{
"name": "",
"status": "info",
"notifications": [],
"condition": "a > 0"
}
],
"hasExtendedTitle": true,
"isEnabled": true,
"message": "My security monitoring rule message.",
"name": "My security monitoring rule.",
"options": {
"decreaseCriticalityBasedOnEnv": false,
"detectionMethod": "threshold",
"evaluationWindow": 0,
"keepAlive": 0,
"maxSignalDuration": 0
},
"queries": [
{
"query": "source:source_here",
"groupByFields": [
"@userIdentity.assumed_role"
],
"distinctFields": [],
"aggregation": "count",
"name": ""
}
],
"tags": [
"env:prod",
"team:security"
],
"type": "log_detection"
},
"ruleQueryPayloads": [
{
"expectedResult": true,
"index": 0,
"payload": {
"ddsource": "source_here",
"ddtags": "env:staging,version:5.1",
"hostname": "i-012345678",
"message": "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World",
"service": "payment",
"userIdentity": {
"assumed_role": "fake assumed_role"
}
}
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/rules/test" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"rule": {
"cases": [
{
"name": "",
"status": "info",
"notifications": [],
"condition": "a > 0"
}
],
"hasExtendedTitle": true,
"isEnabled": true,
"message": "My security monitoring rule message.",
"name": "My security monitoring rule.",
"options": {
"decreaseCriticalityBasedOnEnv": false,
"detectionMethod": "threshold",
"evaluationWindow": 0,
"keepAlive": 0,
"maxSignalDuration": 0
},
"queries": [
{
"query": "source:source_here",
"groupByFields": [
"@userIdentity.assumed_role"
],
"distinctFields": [],
"aggregation": "count",
"name": ""
}
],
"tags": [
"env:prod",
"team:security"
],
"type": "log_detection"
},
"ruleQueryPayloads": [
{
"expectedResult": true,
"index": 0,
"payload": {
"ddsource": "source_here",
"ddtags": "env:staging,version:5.1",
"hostname": "i-012345678",
"message": "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World",
"service": "payment",
"userIdentity": {
"assumed_role": "fake assumed_role"
}
}
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/rules/test" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"rule": {
"cases": [
{
"name": "",
"status": "info",
"notifications": [],
"condition": "a > 0"
}
],
"hasExtendedTitle": true,
"isEnabled": true,
"message": "My security monitoring rule message.",
"name": "My security monitoring rule.",
"options": {
"decreaseCriticalityBasedOnEnv": false,
"detectionMethod": "threshold",
"evaluationWindow": 0,
"keepAlive": 0,
"maxSignalDuration": 0
},
"queries": [
{
"query": "source:source_here",
"groupByFields": [
"@userIdentity.assumed_role"
],
"distinctFields": [],
"aggregation": "count",
"name": ""
}
],
"tags": [
"env:prod",
"team:security"
],
"type": "log_detection"
},
"ruleQueryPayloads": [
{
"expectedResult": true,
"index": 0,
"payload": {
"ddsource": "source_here",
"ddtags": "env:staging,version:5.1",
"hostname": "i-012345678",
"message": "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World",
"service": "payment",
"userIdentity": {
"assumed_role": "fake assumed_role"
}
}
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/rules/test" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"rule": {
"cases": [
{
"name": "",
"status": "info",
"notifications": [],
"condition": "a > 0"
}
],
"hasExtendedTitle": true,
"isEnabled": true,
"message": "My security monitoring rule message.",
"name": "My security monitoring rule.",
"options": {
"decreaseCriticalityBasedOnEnv": false,
"detectionMethod": "threshold",
"evaluationWindow": 0,
"keepAlive": 0,
"maxSignalDuration": 0
},
"queries": [
{
"query": "source:source_here",
"groupByFields": [
"@userIdentity.assumed_role"
],
"distinctFields": [],
"aggregation": "count",
"name": ""
}
],
"tags": [
"env:prod",
"team:security"
],
"type": "log_detection"
},
"ruleQueryPayloads": [
{
"expectedResult": true,
"index": 0,
"payload": {
"ddsource": "source_here",
"ddtags": "env:staging,version:5.1",
"hostname": "i-012345678",
"message": "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World",
"service": "payment",
"userIdentity": {
"assumed_role": "fake assumed_role"
}
}
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/rules/test" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"rule": {
"cases": [
{
"name": "",
"status": "info",
"notifications": [],
"condition": "a > 0"
}
],
"hasExtendedTitle": true,
"isEnabled": true,
"message": "My security monitoring rule message.",
"name": "My security monitoring rule.",
"options": {
"decreaseCriticalityBasedOnEnv": false,
"detectionMethod": "threshold",
"evaluationWindow": 0,
"keepAlive": 0,
"maxSignalDuration": 0
},
"queries": [
{
"query": "source:source_here",
"groupByFields": [
"@userIdentity.assumed_role"
],
"distinctFields": [],
"aggregation": "count",
"name": ""
}
],
"tags": [
"env:prod",
"team:security"
],
"type": "log_detection"
},
"ruleQueryPayloads": [
{
"expectedResult": true,
"index": 0,
"payload": {
"ddsource": "source_here",
"ddtags": "env:staging,version:5.1",
"hostname": "i-012345678",
"message": "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World",
"service": "payment",
"userIdentity": {
"assumed_role": "fake assumed_role"
}
}
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/rules/test" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"rule": {
"cases": [
{
"name": "",
"status": "info",
"notifications": [],
"condition": "a > 0"
}
],
"hasExtendedTitle": true,
"isEnabled": true,
"message": "My security monitoring rule message.",
"name": "My security monitoring rule.",
"options": {
"decreaseCriticalityBasedOnEnv": false,
"detectionMethod": "threshold",
"evaluationWindow": 0,
"keepAlive": 0,
"maxSignalDuration": 0
},
"queries": [
{
"query": "source:source_here",
"groupByFields": [
"@userIdentity.assumed_role"
],
"distinctFields": [],
"aggregation": "count",
"name": ""
}
],
"tags": [
"env:prod",
"team:security"
],
"type": "log_detection"
},
"ruleQueryPayloads": [
{
"expectedResult": true,
"index": 0,
"payload": {
"ddsource": "source_here",
"ddtags": "env:staging,version:5.1",
"hostname": "i-012345678",
"message": "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World",
"service": "payment",
"userIdentity": {
"assumed_role": "fake assumed_role"
}
}
}
]
}
EOF# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/security_monitoring/rules/test" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"rule": {
"cases": [
{
"name": "",
"status": "info",
"notifications": [],
"condition": "a > 0"
}
],
"hasExtendedTitle": true,
"isEnabled": true,
"message": "My security monitoring rule message.",
"name": "My security monitoring rule.",
"options": {
"decreaseCriticalityBasedOnEnv": false,
"detectionMethod": "threshold",
"evaluationWindow": 0,
"keepAlive": 0,
"maxSignalDuration": 0
},
"queries": [
{
"query": "source:source_here",
"groupByFields": [
"@userIdentity.assumed_role"
],
"distinctFields": [],
"aggregation": "count",
"name": ""
}
],
"tags": [
"env:prod",
"team:security"
],
"type": "log_detection"
},
"ruleQueryPayloads": [
{
"expectedResult": true,
"index": 0,
"payload": {
"ddsource": "source_here",
"ddtags": "env:staging,version:5.1",
"hostname": "i-012345678",
"message": "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World",
"service": "payment",
"userIdentity": {
"assumed_role": "fake assumed_role"
}
}
}
]
}
EOFTest a rule returns "OK" response
// Test a rule returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
body := datadogV2.SecurityMonitoringRuleTestRequest{
Rule: &datadogV2.SecurityMonitoringRuleTestPayload{
SecurityMonitoringStandardRuleTestPayload: &datadogV2.SecurityMonitoringStandardRuleTestPayload{
Cases: []datadogV2.SecurityMonitoringRuleCaseCreate{
{
Name: datadog.PtrString(""),
Status: datadogV2.SECURITYMONITORINGRULESEVERITY_INFO,
Notifications: []string{},
Condition: datadog.PtrString("a > 0"),
},
},
HasExtendedTitle: datadog.PtrBool(true),
IsEnabled: true,
Message: "My security monitoring rule message.",
Name: "My security monitoring rule.",
Options: datadogV2.SecurityMonitoringRuleOptions{
DecreaseCriticalityBasedOnEnv: datadog.PtrBool(false),
DetectionMethod: datadogV2.SECURITYMONITORINGRULEDETECTIONMETHOD_THRESHOLD.Ptr(),
EvaluationWindow: datadogV2.SECURITYMONITORINGRULEEVALUATIONWINDOW_ZERO_MINUTES.Ptr(),
KeepAlive: datadogV2.SECURITYMONITORINGRULEKEEPALIVE_ZERO_MINUTES.Ptr(),
MaxSignalDuration: datadogV2.SECURITYMONITORINGRULEMAXSIGNALDURATION_ZERO_MINUTES.Ptr(),
},
Queries: []datadogV2.SecurityMonitoringStandardRuleQuery{
{
Query: datadog.PtrString("source:source_here"),
GroupByFields: []string{
"@userIdentity.assumed_role",
},
DistinctFields: []string{},
Aggregation: datadogV2.SECURITYMONITORINGRULEQUERYAGGREGATION_COUNT.Ptr(),
Name: datadog.PtrString(""),
},
},
Tags: []string{
"env:prod",
"team:security",
},
Type: datadogV2.SECURITYMONITORINGRULETYPETEST_LOG_DETECTION.Ptr(),
}},
RuleQueryPayloads: []datadogV2.SecurityMonitoringRuleQueryPayload{
{
ExpectedResult: datadog.PtrBool(true),
Index: datadog.PtrInt64(0),
Payload: &datadogV2.SecurityMonitoringRuleQueryPayloadData{
Ddsource: datadog.PtrString("source_here"),
Ddtags: datadog.PtrString("env:staging,version:5.1"),
Hostname: datadog.PtrString("i-012345678"),
Message: datadog.PtrString("2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World"),
Service: datadog.PtrString("payment"),
AdditionalProperties: map[string]interface{}{
"userIdentity": "{'assumed_role': 'fake assumed_role'}",
},
},
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewSecurityMonitoringApi(apiClient)
resp, r, err := api.TestSecurityMonitoringRule(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `SecurityMonitoringApi.TestSecurityMonitoringRule`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `SecurityMonitoringApi.TestSecurityMonitoringRule`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"Test a rule returns "OK" response
// Test a rule returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.SecurityMonitoringApi;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleCaseCreate;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleDetectionMethod;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleEvaluationWindow;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleKeepAlive;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleMaxSignalDuration;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleOptions;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleQueryAggregation;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleQueryPayload;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleQueryPayloadData;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleSeverity;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleTestPayload;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleTestRequest;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleTestResponse;
import com.datadog.api.client.v2.model.SecurityMonitoringRuleTypeTest;
import com.datadog.api.client.v2.model.SecurityMonitoringStandardRuleQuery;
import com.datadog.api.client.v2.model.SecurityMonitoringStandardRuleTestPayload;
import java.util.Arrays;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
SecurityMonitoringApi apiInstance = new SecurityMonitoringApi(defaultClient);
SecurityMonitoringRuleTestRequest body =
new SecurityMonitoringRuleTestRequest()
.rule(
new SecurityMonitoringRuleTestPayload(
new SecurityMonitoringStandardRuleTestPayload()
.cases(
Collections.singletonList(
new SecurityMonitoringRuleCaseCreate()
.name("")
.status(SecurityMonitoringRuleSeverity.INFO)
.condition("a > 0")))
.hasExtendedTitle(true)
.isEnabled(true)
.message("My security monitoring rule message.")
.name("My security monitoring rule.")
.options(
new SecurityMonitoringRuleOptions()
.decreaseCriticalityBasedOnEnv(false)
.detectionMethod(SecurityMonitoringRuleDetectionMethod.THRESHOLD)
.evaluationWindow(
SecurityMonitoringRuleEvaluationWindow.ZERO_MINUTES)
.keepAlive(SecurityMonitoringRuleKeepAlive.ZERO_MINUTES)
.maxSignalDuration(
SecurityMonitoringRuleMaxSignalDuration.ZERO_MINUTES))
.queries(
Collections.singletonList(
new SecurityMonitoringStandardRuleQuery()
.query("source:source_here")
.groupByFields(
Collections.singletonList("@userIdentity.assumed_role"))
.aggregation(SecurityMonitoringRuleQueryAggregation.COUNT)
.name("")))
.tags(Arrays.asList("env:prod", "team:security"))
.type(SecurityMonitoringRuleTypeTest.LOG_DETECTION)))
.ruleQueryPayloads(
Collections.singletonList(
new SecurityMonitoringRuleQueryPayload()
.expectedResult(true)
.index(0L)
.payload(
new SecurityMonitoringRuleQueryPayloadData()
.ddsource("source_here")
.ddtags("env:staging,version:5.1")
.hostname("i-012345678")
.message(
"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello"
+ " World")
.service("payment"))));
try {
SecurityMonitoringRuleTestResponse result = apiInstance.testSecurityMonitoringRule(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SecurityMonitoringApi#testSecurityMonitoringRule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Instructions
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"Test a rule returns "OK" response
"""
Test a rule returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
from datadog_api_client.v2.model.security_monitoring_rule_case_create import SecurityMonitoringRuleCaseCreate
from datadog_api_client.v2.model.security_monitoring_rule_detection_method import SecurityMonitoringRuleDetectionMethod
from datadog_api_client.v2.model.security_monitoring_rule_evaluation_window import (
SecurityMonitoringRuleEvaluationWindow,
)
from datadog_api_client.v2.model.security_monitoring_rule_keep_alive import SecurityMonitoringRuleKeepAlive
from datadog_api_client.v2.model.security_monitoring_rule_max_signal_duration import (
SecurityMonitoringRuleMaxSignalDuration,
)
from datadog_api_client.v2.model.security_monitoring_rule_options import SecurityMonitoringRuleOptions
from datadog_api_client.v2.model.security_monitoring_rule_query_aggregation import (
SecurityMonitoringRuleQueryAggregation,
)
from datadog_api_client.v2.model.security_monitoring_rule_query_payload import SecurityMonitoringRuleQueryPayload
from datadog_api_client.v2.model.security_monitoring_rule_query_payload_data import (
SecurityMonitoringRuleQueryPayloadData,
)
from datadog_api_client.v2.model.security_monitoring_rule_severity import SecurityMonitoringRuleSeverity
from datadog_api_client.v2.model.security_monitoring_rule_test_request import SecurityMonitoringRuleTestRequest
from datadog_api_client.v2.model.security_monitoring_rule_type_test import SecurityMonitoringRuleTypeTest
from datadog_api_client.v2.model.security_monitoring_standard_rule_query import SecurityMonitoringStandardRuleQuery
from datadog_api_client.v2.model.security_monitoring_standard_rule_test_payload import (
SecurityMonitoringStandardRuleTestPayload,
)
body = SecurityMonitoringRuleTestRequest(
rule=SecurityMonitoringStandardRuleTestPayload(
cases=[
SecurityMonitoringRuleCaseCreate(
name="",
status=SecurityMonitoringRuleSeverity.INFO,
notifications=[],
condition="a > 0",
),
],
has_extended_title=True,
is_enabled=True,
message="My security monitoring rule message.",
name="My security monitoring rule.",
options=SecurityMonitoringRuleOptions(
decrease_criticality_based_on_env=False,
detection_method=SecurityMonitoringRuleDetectionMethod.THRESHOLD,
evaluation_window=SecurityMonitoringRuleEvaluationWindow.ZERO_MINUTES,
keep_alive=SecurityMonitoringRuleKeepAlive.ZERO_MINUTES,
max_signal_duration=SecurityMonitoringRuleMaxSignalDuration.ZERO_MINUTES,
),
queries=[
SecurityMonitoringStandardRuleQuery(
query="source:source_here",
group_by_fields=[
"@userIdentity.assumed_role",
],
distinct_fields=[],
aggregation=SecurityMonitoringRuleQueryAggregation.COUNT,
name="",
),
],
tags=[
"env:prod",
"team:security",
],
type=SecurityMonitoringRuleTypeTest.LOG_DETECTION,
),
rule_query_payloads=[
SecurityMonitoringRuleQueryPayload(
expected_result=True,
index=0,
payload=SecurityMonitoringRuleQueryPayloadData(
ddsource="source_here",
ddtags="env:staging,version:5.1",
hostname="i-012345678",
message="2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World",
service="payment",
user_identity=dict([("assumed_role", "fake assumed_role")]),
),
),
],
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = SecurityMonitoringApi(api_client)
response = api_instance.test_security_monitoring_rule(body=body)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"Test a rule returns "OK" response
# Test a rule returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
body = DatadogAPIClient::V2::SecurityMonitoringRuleTestRequest.new({
rule: DatadogAPIClient::V2::SecurityMonitoringStandardRuleTestPayload.new({
cases: [
DatadogAPIClient::V2::SecurityMonitoringRuleCaseCreate.new({
name: "",
status: DatadogAPIClient::V2::SecurityMonitoringRuleSeverity::INFO,
notifications: [],
condition: "a > 0",
}),
],
has_extended_title: true,
is_enabled: true,
message: "My security monitoring rule message.",
name: "My security monitoring rule.",
options: DatadogAPIClient::V2::SecurityMonitoringRuleOptions.new({
decrease_criticality_based_on_env: false,
detection_method: DatadogAPIClient::V2::SecurityMonitoringRuleDetectionMethod::THRESHOLD,
evaluation_window: DatadogAPIClient::V2::SecurityMonitoringRuleEvaluationWindow::ZERO_MINUTES,
keep_alive: DatadogAPIClient::V2::SecurityMonitoringRuleKeepAlive::ZERO_MINUTES,
max_signal_duration: DatadogAPIClient::V2::SecurityMonitoringRuleMaxSignalDuration::ZERO_MINUTES,
}),
queries: [
DatadogAPIClient::V2::SecurityMonitoringStandardRuleQuery.new({
query: "source:source_here",
group_by_fields: [
"@userIdentity.assumed_role",
],
distinct_fields: [],
aggregation: DatadogAPIClient::V2::SecurityMonitoringRuleQueryAggregation::COUNT,
name: "",
}),
],
tags: [
"env:prod",
"team:security",
],
type: DatadogAPIClient::V2::SecurityMonitoringRuleTypeTest::LOG_DETECTION,
}),
rule_query_payloads: [
DatadogAPIClient::V2::SecurityMonitoringRuleQueryPayload.new({
expected_result: true,
index: 0,
payload: DatadogAPIClient::V2::SecurityMonitoringRuleQueryPayloadData.new({
ddsource: "source_here",
ddtags: "env:staging,version:5.1",
hostname: "i-012345678",
message: "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World",
service: "payment",
}),
}),
],
})
p api_instance.test_security_monitoring_rule(body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"Test a rule returns "OK" response
// Test a rule returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_security_monitoring::SecurityMonitoringAPI;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleCaseCreate;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleDetectionMethod;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleEvaluationWindow;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleKeepAlive;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleMaxSignalDuration;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleOptions;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleQueryAggregation;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleQueryPayload;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleQueryPayloadData;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleSeverity;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleTestPayload;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleTestRequest;
use datadog_api_client::datadogV2::model::SecurityMonitoringRuleTypeTest;
use datadog_api_client::datadogV2::model::SecurityMonitoringStandardRuleQuery;
use datadog_api_client::datadogV2::model::SecurityMonitoringStandardRuleTestPayload;
#[tokio::main]
async fn main() {
let body = SecurityMonitoringRuleTestRequest::new()
.rule(
SecurityMonitoringRuleTestPayload::SecurityMonitoringStandardRuleTestPayload(Box::new(
SecurityMonitoringStandardRuleTestPayload::new(
vec![SecurityMonitoringRuleCaseCreate::new(
SecurityMonitoringRuleSeverity::INFO,
)
.condition("a > 0".to_string())
.name("".to_string())
.notifications(vec![])],
true,
"My security monitoring rule message.".to_string(),
"My security monitoring rule.".to_string(),
SecurityMonitoringRuleOptions::new()
.decrease_criticality_based_on_env(false)
.detection_method(SecurityMonitoringRuleDetectionMethod::THRESHOLD)
.evaluation_window(SecurityMonitoringRuleEvaluationWindow::ZERO_MINUTES)
.keep_alive(SecurityMonitoringRuleKeepAlive::ZERO_MINUTES)
.max_signal_duration(SecurityMonitoringRuleMaxSignalDuration::ZERO_MINUTES),
vec![SecurityMonitoringStandardRuleQuery::new()
.aggregation(SecurityMonitoringRuleQueryAggregation::COUNT)
.distinct_fields(vec![])
.group_by_fields(vec!["@userIdentity.assumed_role".to_string()])
.name("".to_string())
.query("source:source_here".to_string())],
)
.has_extended_title(true)
.tags(vec!["env:prod".to_string(), "team:security".to_string()])
.type_(SecurityMonitoringRuleTypeTest::LOG_DETECTION),
)),
)
.rule_query_payloads(vec![SecurityMonitoringRuleQueryPayload::new()
.expected_result(true)
.index(0)
.payload(
SecurityMonitoringRuleQueryPayloadData::new()
.ddsource("source_here".to_string())
.ddtags("env:staging,version:5.1".to_string())
.hostname("i-012345678".to_string())
.message(
"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World"
.to_string(),
)
.service("payment".to_string()),
)]);
let configuration = datadog::Configuration::new();
let api = SecurityMonitoringAPI::with_config(configuration);
let resp = api.test_security_monitoring_rule(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Instructions
First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runTest a rule returns "OK" response
/**
* Test a rule returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
const apiInstance = new v2.SecurityMonitoringApi(configuration);
const params: v2.SecurityMonitoringApiTestSecurityMonitoringRuleRequest = {
body: {
rule: {
cases: [
{
name: "",
status: "info",
notifications: [],
condition: "a > 0",
},
],
hasExtendedTitle: true,
isEnabled: true,
message: "My security monitoring rule message.",
name: "My security monitoring rule.",
options: {
decreaseCriticalityBasedOnEnv: false,
detectionMethod: "threshold",
evaluationWindow: 0,
keepAlive: 0,
maxSignalDuration: 0,
},
queries: [
{
query: "source:source_here",
groupByFields: ["@userIdentity.assumed_role"],
distinctFields: [],
aggregation: "count",
name: "",
},
],
tags: ["env:prod", "team:security"],
type: "log_detection",
},
ruleQueryPayloads: [
{
expectedResult: true,
index: 0,
payload: {
ddsource: "source_here",
ddtags: "env:staging,version:5.1",
hostname: "i-012345678",
message:
"2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World",
service: "payment",
},
},
],
},
};
apiInstance
.testSecurityMonitoringRule(params)
.then((data: v2.SecurityMonitoringRuleTestResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Instructions
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"