Datadog Tests API is one of 290 APIs that Datadog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include Tests. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 4 JSON Schemas.
This API exposes
5 operations
across 5 paths,
and defines 80 schemas.
It is described by OpenAPI 3.0.0, at version 1.0.
Requests are made against 3 base URLs: https://{subdomain}.{site}, {protocol}://{name}, https://{subdomain}.{site}.
The identity and technical contract details declared by the specification.
SecurityMonitoringRuleEvaluationWindow
integer
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…
CIAppGroupByTotal
A resulting object to put the given computes in over all the matching records.
CIAppAggregateBucketValueSingleString
string
A single string value.
SecurityMonitoringRuleMaxSignalDuration
integer
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.
CIAppComputeType
string
The type of compute.
SecurityMonitoringRuleCaseActionOptionsUserBehaviorName
string
Used with the case action of type 'userbehavior'. The value specified in this field is applied as a risk tag to all users affected by the rule.
SecurityMonitoringRuleNewValueOptionsLearningThreshold
integer
A number of occurrences after which signals will be generated for values that weren't learned.
SecurityMonitoringRuleNewValueOptionsForgetAfter
integer
The duration in days after which a learned value is forgotten.
CIAppGroupByMissing
The value to use for logs that don't have the facet used to group-by.
SecurityMonitoringRuleQueryAggregation
string
The aggregation type.
SecurityMonitoringRuleTypeTest
string
The rule type.
CIAppCompute
object
A compute rule to compute metrics or timeseries.
4 properties
1 required
SecurityMonitoringRuleTestResponse
object
Result of the test of the rule queries.
1 property
SecurityMonitoringStandardRuleQuery
object
Query for matching rule.
9 properties
SecurityMonitoringFilterAction
string
The type of filtering action.
CIAppTestsQueryFilter
object
The search and filter query settings.
3 properties
CIAppTestEvent
object
Object description of test event after being processed and stored by Datadog.
3 properties
SecurityMonitoringRuleThirdPartyOptions
object
Options on third party detection method.
4 properties
CIAppTestsAggregateRequest
object
The object sent with the request to retrieve aggregation buckets of test events from your organization.
4 properties
SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv
boolean
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 dec…
SecurityMonitoringRuleQueryPayloadData
object
Payload used to test the rule query.
5 properties
CIAppGroupByTotalNumber
number
A number to use as the key value for the total bucket.
CIAppAggregateBucketValueSingleNumber
number
A single number value.
CIAppWarning
object
A warning message indicating something that went wrong with the query.
3 properties
CIAppAggregateSort
object
A sort rule. The aggregation field is required when type is measure.
4 properties
SecurityMonitoringRuleCaseActionType
string
The action type.
CIAppTestEventsRequest
object
The request for a tests search.
4 properties
CIAppComputes
object
A map of the metric name to value for regular compute, or a list of values for a timeseries.
SecurityMonitoringRuleHardcodedEvaluatorType
string
Hardcoded evaluator type.
SecurityMonitoringStandardDataSource
string
Source of events, either logs, audit trail, or Datadog events.
CIAppTestsGroupBy
object
A group-by rule.
6 properties
1 required
SecurityMonitoringRuleCaseActionOptions
object
Options for the rule action
2 properties
CIAppGroupByMissingNumber
number
The missing value to use if there is a number valued facet.
CIAppResponseStatus
string
The status of the response.
CIAppTestEventsResponse
object
Response object with all test events matching the request and pagination information.
3 properties
CIAppAggregateSortType
string
The type of sorting algorithm.
SecurityMonitoringRuleOptions
object
Options.
10 properties
SecurityMonitoringRuleTestPayload
Test a rule.
CIAppGroupByMissingString
string
The missing value to use if there is a string valued facet.
SecurityMonitoringRuleQueryPayload
object
Payload to test a rule query with the expected result.
3 properties
SecurityMonitoringThirdPartyRuleCaseCreate
object
Case when a signal is generated by a third party rule.
4 properties
1 required
SecurityMonitoringReferenceTable
object
Reference tables used in the queries.
5 properties
CIAppTestLevel
string
Test run level.
SecurityMonitoringRuleKeepAlive
integer
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, t…
SecurityMonitoringRuleSeverity
string
Severity of the Security Signal.
CIAppAggregateBucketValueTimeseries
array
A timeseries array.
CIAppGroupByTotalString
string
A string to use as the key value for the total bucket.
CIAppAggregateBucketValue
A bucket value, can either be a timeseries or a single value.
CIAppGroupByHistogram
object
Used to perform a histogram computation (only for measure facets). At most, 100 buckets are allowed, the number of buckets is (max - min)/interval.
3 properties
3 required
APIErrorResponse
object
API error response.
1 property
1 required
CIAppTestsBucketResponse
object
Bucket values.
2 properties
CloudConfigurationRegoRule
object
Rule details.
2 properties
2 required
CIAppAggregationFunction
string
An aggregation function.
CIAppTestsAnalyticsAggregateResponse
object
The response object for the test events aggregate API endpoint.
3 properties
SecurityMonitoringRuleCaseCreate
object
Case when signal is generated.
5 properties
1 required
TagsEventAttribute
array
Array of tags associated with your event.
CIAppAggregateBucketValueTimeseriesPoint
object
A timeseries point.
2 properties
CIAppQueryOptions
object
Global query options that are used during the query. Only supply timezone or time offset, not both. Otherwise, the query fails.
2 properties
CIAppResponseMetadataWithPagination
object
The metadata associated with a request.
5 properties
SecurityMonitoringRuleImpossibleTravelOptions
object
Options on impossible travel detection method.
1 property
CloudConfigurationComplianceRuleOptions
object
Options for cloudconfiguration rules. Fields resourceType and regoRule are mandatory when managing custom cloudconfiguration rules.
3 properties
SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations
boolean
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 a…
CIAppTestsAggregationBucketsResponse
object
The query results.
1 property
CIAppTestEventTypeName
string
Type of the event.
CIAppQueryPageOptions
object
Paging attributes for listing events.
2 properties
CIAppEventAttributes
object
JSON object containing all event attributes and their associated values.
3 properties
SecurityMonitoringThirdPartyRootQuery
object
A query to be combined with the third party case query.
2 properties
SecurityMonitoringRuleNewValueOptionsLearningMethod
string
The learning method used to determine when signals should be generated for values that weren't learned.
SecurityMonitoringRuleCaseAction
object
Action to perform when a signal is triggered. Only available for Application Security rule type.
2 properties
CIAppResponsePage
object
Paging attributes.
1 property
CIAppSort
string
Sort parameters when querying events.
SecurityMonitoringRuleNewValueOptionsLearningDuration
integer
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…
SecurityMonitoringRuleNewValueOptions
object
Options on new value detection method.
4 properties
SecurityMonitoringStandardRuleTestPayload
object
The payload of a rule to test
13 properties
6 required
SecurityMonitoringFilter
object
The rule's suppression filter.
2 properties
CIAppResponseLinks
object
Links attributes.
1 property
CIAppSortOrder
string
The order to use, ascending or descending.
CIAppGroupByTotalBoolean
boolean
If set to true, creates an additional bucket labeled "$facettotal".
SecurityMonitoringRuleDetectionMethod
string
The detection method.
SecurityMonitoringRuleTestRequest
object
Test the rule queries of a rule (rule property is ignored when applied to an existing rule)
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Datadog publishes across the network.
