v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

APM Retention Filters

Update a retention filter

Update a retention filter from your organization.

Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor) cannot be renamed or removed.

put/api/v2/apm/config/retention-filters/{filter_id}

Path parameters

filter_idstring required

The ID of the retention filter.

Request body

Example request

{
  "data": {
    "attributes": {
      "enabled": true,
      "filter": {
        "query": "@http.status_code:200 service:my-service"
      },
      "filter_type": "spans-sampling-processor",
      "name": "my retention filter",
      "rate": 1,
      "trace_rate": 1
    },
    "id": "retention-filter-id",
    "type": "apm_retention_filter"
  }
}

Response

Example response

{
  "data": {
    "attributes": {
      "editable": true,
      "enabled": true,
      "filter": {
        "query": "@http.status_code:200 service:my-service"
      },
      "filter_type": "spans-sampling-processor",
      "name": "my retention filter",
      "rate": 1,
      "trace_rate": 1
    },
    "id": "7RBOb7dLSYWI01yc3pIH8w",
    "type": "apm_retention_filter"
  }
}