Update a Custom Inbound Filter

ExperimentalThis API is under active development and may change.
PUT /api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/custom-inbound-filters/{filter_id}/

Update a custom inbound filter's name, active state, or conditions.

Path Parameters

organization_id_or_slug (string)
REQUIRED

The ID or slug of the organization the resource belongs to.

project_id_or_slug (string)
REQUIRED

The ID or slug of the project the resource belongs to. Project slugs are unique within each organization.

filter_id (string)
REQUIRED

The ID of the custom inbound filter.

Body Parameters

id (string)
REQUIRED

The ID of the filter.

dataType (string)
REQUIRED

The data the filter matches against. all is the catch-all: it filters every data type Sentry ingests, including ones added later, and accepts only the conditions that every data type carries a field for.

  • all
  • error
  • log
  • metric
  • span
conditions (array(object))
REQUIRED

Conditions are combined with AND: an event must match every condition to be filtered out. There is no OR between conditions, so e.g. two release conditions can express a range (gte 2.0 and lt 4.0). To broaden matching, widen a condition's values or add separate filters.

dateCreated (string)
REQUIRED

When the filter was created.

dateUpdated (string)
REQUIRED

When the filter was last changed.

legacyFilter (string)
REQUIRED

Set on a filter that holds one of the filter lists of the project settings, to the id its outcomes are reported under. Such a filter keeps its data type and its one condition: only the name, the active flag and the condition values can change, and deleting it empties the list.

name (string)

A human-readable label for the filter.

active (boolean)

Whether the filter drops matching data. An inactive filter is kept but ignored.

Scopes

<auth_token> requires one of the following scopes:
  • project:admin
  • project:write
Copied
curl https://sentry.io/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/custom-inbound-filters/{filter_id}/ \
 -H 'Authorization: Bearer <auth_token>' \
 -X PUT \
 -H 'Content-Type: application/json' \
 -d '{}'
RESPONSESCHEMA
Copied
{
  "id": "42",
  "name": "Drop TypeErrors from the 1.x releases",
  "active": true,
  "dataType": "error",
  "conditions": [
    {
      "type": "error_type",
      "operator": "equals",
      "value": [
        "TypeError"
      ]
    },
    {
      "type": "error_message",
      "operator": "contains",
      "value": [
        "undefined"
      ]
    },
    {
      "type": "release",
      "operator": "lt",
      "value": [
        "2.0.0"
      ]
    }
  ],
  "dateCreated": "2024-07-23T17:52:53.981206Z",
  "dateUpdated": "2024-07-23T17:52:53.981206Z",
  "legacyFilter": null
}
Was this helpful?