Datadog Filter 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 Filter. 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
16 operations
across 8 paths,
and defines 65 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.
RumRetentionFilterEnabled
boolean
Whether the retention filter is enabled.
SpansFilterCreate
object
The spans filter. Spans matching this filter will be indexed and stored.
1 property
1 required
SecurityFilterExclusionFilter
object
Exclusion filter for the security filter.
2 properties
2 required
RetentionFilterAll
object
The definition of the retention filter.
3 properties
3 required
RumRetentionFilterType
string
The type of the resource. The value should always be retentionfilters.
RetentionFilterCreateAttributes
object
The object describing the configuration of the retention filter to create/update.
6 properties
5 required
SecurityFilterFilteredDataType
string
The filtered data type.
ApplicationSecurityWafExclusionFilterResource
object
A JSON:API resource for an WAF exclusion filter.
3 properties
ApplicationSecurityWafExclusionFilterScope
object
Deploy on services based on their environment and/or service name.
2 properties
SecurityFilterUpdateData
object
The new security filter properties.
2 properties
2 required
ApplicationSecurityWafExclusionFilterUpdateData
object
Object for updating a single WAF exclusion filter.
2 properties
2 required
RumRetentionFilterUpdateAttributes
object
The object describing attributes of a RUM retention filter to update.
5 properties
ApplicationSecurityWafExclusionFilterCreateRequest
object
Request object for creating a single WAF exclusion filter.
1 property
1 required
RumRetentionFilterQuery
string
The query string for a RUM retention filter.
RetentionFilterAllType
string
The type of retention filter.
APIErrorResponse
object
API error response.
1 property
1 required
SecurityFilter
object
The security filter's properties.
3 properties
RumRetentionFilterCreateRequest
object
The RUM retention filter body to create.
1 property
1 required
RetentionFilterCreateRequest
object
The body of the retention filter to be created.
1 property
1 required
RumRetentionFilterEventType
string
The type of RUM events to filter on.
ApplicationSecurityWafExclusionFilterUpdateAttributes
object
Attributes for updating a WAF exclusion filter.
8 properties
2 required
RetentionFilterResponse
object
The retention filters definition.
1 property
SecurityFilterType
string
The type of the resource. The value should always be securityfilters.
RetentionFilter
object
The definition of the retention filter.
3 properties
3 required
RetentionFilterCreateData
object
The body of the retention filter to be created.
2 properties
2 required
RumRetentionFilterCreateData
object
The new RUM retention filter properties to create.
2 properties
2 required
RumRetentionFilterSampleRate
integer
The sample rate for a RUM retention filter, between 0 and 100.
RetentionFilterUpdateData
object
The body of the retention filter to be updated.
3 properties
3 required
SecurityFilterCreateData
object
Object for a single security filter.
2 properties
2 required
ApplicationSecurityWafExclusionFilterUpdateRequest
object
Request object for updating a single WAF exclusion filter.
1 property
1 required
RetentionFilterAllAttributes
object
The attributes of the retention filter.
12 properties
RunRetentionFilterName
string
The name of a RUM retention filter.
RumRetentionFilterID
string
ID of retention filter in UUID.
ApplicationSecurityWafExclusionFilterAttributes
object
Attributes describing a WAF exclusion filter.
11 properties
SecurityFilterMeta
object
Optional metadata associated to the response.
1 property
RetentionFilterUpdateAttributes
object
The object describing the configuration of the retention filter to create/update.
6 properties
5 required
RetentionFilterAttributes
object
The attributes of the retention filter.
12 properties
RumRetentionFilterUpdateRequest
object
The RUM retention filter body to update.
1 property
1 required
SecurityFilterExclusionFilterResponse
object
A single exclusion filter.
2 properties
ApplicationSecurityWafExclusionFilterResponse
object
Response object for a single WAF exclusion filter.
1 property
ApplicationSecurityWafExclusionFilterCreateAttributes
object
Attributes for creating a WAF exclusion filter.
8 properties
2 required
SecurityFilterID
string
The ID of the security filter.
ApplicationSecurityWafExclusionFilterMetadata
object
Extra information about the exclusion filter.
6 properties
RumRetentionFilterData
object
The RUM retention filter.
3 properties
RumRetentionFilterAttributes
object
The object describing attributes of a RUM retention filter.
5 properties
ApmRetentionFilterType
string
The type of the resource.
SecurityFilterCreateAttributes
object
Object containing the attributes of the security filter to be created.
5 properties
5 required
RetentionFilterType
string
The type of retention filter. The value should always be spans-sampling-processor.
SecurityFilterUpdateAttributes
object
The security filters properties to be updated.
6 properties
SpansFilter
object
The spans filter used to index spans.
1 property
ApplicationSecurityWafExclusionFilterRulesTarget
object
Target WAF rules based either on an identifier or tags.
2 properties
ApplicationSecurityWafExclusionFilterOnMatch
string
The action taken when the exclusion filter matches. When set to monitor, security traces are emitted but the requests are not blocked. By default, security tra…
ApplicationSecurityWafExclusionFilterType
string
Type of the resource. The value should always be exclusionfilter.
SecurityFilterUpdateRequest
object
The new security filter body.
1 property
1 required
SecurityFilterCreateRequest
object
Request object that includes the security filter that you would like to create.
1 property
1 required
ApplicationSecurityWafExclusionFilterRulesTargetTags
object
Target multiple WAF rules based on their tags.
2 properties
ApplicationSecurityWafExclusionFilterID
string
The identifier of the WAF exclusion filter.
RumRetentionFilterUpdateData
object
The new RUM retention filter properties to update.
3 properties
3 required
RetentionFilterCreateResponse
object
The retention filters definition.
1 property
RetentionFilterUpdateRequest
object
The body of the retention filter to be updated.
1 property
1 required
ApplicationSecurityWafExclusionFilterCreateData
object
Object for creating a single WAF exclusion filter.
2 properties
2 required
SecurityFilterResponse
object
Response object which includes a single security filter.
2 properties
SecurityFilterAttributes
object
The object describing a security filter.
7 properties
RumRetentionFilterCreateAttributes
object
The object describing attributes of a RUM retention filter to create.
5 properties
3 required
RumRetentionFilterResponse
object
The RUM retention filter object.
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Datadog publishes across the network.
