Get the version history of security filters

GET https://api.ap1.datadoghq.com/api/v2/security_monitoring/configuration/security_filters/versionshttps://api.ap2.datadoghq.com/api/v2/security_monitoring/configuration/security_filters/versionshttps://api.datadoghq.eu/api/v2/security_monitoring/configuration/security_filters/versionshttps://api.ddog-gov.com/api/v2/security_monitoring/configuration/security_filters/versionshttps://api.us2.ddog-gov.com/api/v2/security_monitoring/configuration/security_filters/versionshttps://api.datadoghq.com/api/v2/security_monitoring/configuration/security_filters/versionshttps://api.us3.datadoghq.com/api/v2/security_monitoring/configuration/security_filters/versionshttps://api.us5.datadoghq.com/api/v2/security_monitoring/configuration/security_filters/versions

Overview

Get the configured security filters at each historical version of the configuration. Each entry in the response represents the set of all security filters at a given version, ordered from the most recent version to the oldest. This endpoint requires the security_monitoring_filters_read permission.

OAuth apps require the security_monitoring_filters_read authorization scope to access this endpoint.

Response

OK

Response containing the version history of security filters.

Expand All

Field

Type

Description

data [required]

[object]

A list of historical security filter configurations, ordered from the most recent to the oldest.

attributes [required]

object

The attributes describing a single security filter configuration version.

date [required]

int64

The Unix timestamp in milliseconds at which this configuration version was applied.

filters [required]

[object]

The set of security filters at this configuration version.

exclusion_filters [required]

[object]

The list of exclusion filters applied in this security filter.

name

string

The exclusion filter name.

query

string

The exclusion filter query.

filtered_data_type [required]

enum

The filtered data type. Allowed enum values: logs

id [required]

string

The ID of the security filter.

is_builtin [required]

boolean

Whether the security filter is the built-in filter.

is_enabled [required]

boolean

Whether the security filter is enabled.

name [required]

string

The name of the security filter.

query [required]

string

The query of the security filter.

version [required]

int32

The version of this security filter.

version [required]

int32

The configuration version number.

id [required]

string

The identifier of the configuration version.

type [required]

enum

The type of the resource. The value should always be security_filters_configuration. Allowed enum values: security_filters_configuration

default: security_filters_configuration

{
  "data": [
    {
      "attributes": {
        "date": 1758177253469,
        "filters": [
          {
            "exclusion_filters": [
              {
                "name": "Exclude staging",
                "query": "source:staging"
              }
            ],
            "filtered_data_type": "logs",
            "id": "123",
            "is_builtin": false,
            "is_enabled": true,
            "name": "Test Security Filter",
            "query": "source:test",
            "version": 1
          }
        ],
        "version": 1
      },
      "id": "1",
      "type": "security_filters_configuration"
    }
  ]
}

Not Authorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/security_monitoring/configuration/security_filters/versions" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"