Update connector filtering API | Elasticsearch Guide [8.13]

› › ›

« Update connector error API Update connector index name API »

Update connector filtering APIedit

This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Updates the filtering configuration of a connector. Learn more about filtering in the sync rules documentation.

Requestedit

PUT _connector/<connector_id>/_filtering

Prerequisitesedit

To sync data using connectors, it’s essential to have the Elastic connectors service running.
The connector_id parameter should reference an existing connector.

Path parametersedit

<connector_id>: (Required, string)

Request bodyedit

filtering: (Required, array) The filtering configuration for the connector. This configuration determines the set of rules applied for filtering data during syncs.

Each entry in the filtering array represents a set of filtering rules for a specific data domain and includes the following attributes:

domain (Required, string)
Specifies the data domain to which these filtering rules apply.
active (Required, object)
Contains the set of rules that are actively used for sync jobs. The active object includes:
- rules (Required, array of objects)
  An array of individual filtering rule objects, each with the following sub-attributes:
  - id (Required, string)
    A unique identifier for the rule.
  - policy (Required, string)
    Specifies the policy, such as "include" or "exclude".
  - field (Required, string)
    The field in the document to which this rule applies.
  - rule (Required, string)
    The type of rule, such as "regex", "starts_with", "ends_with", "contains", "equals", "<", ">", etc.
  - value (Required, string)
    The value to be used in conjunction with the rule for matching the contents of the document’s field.
  - order (Required, number)
    The order in which the rules are applied. The first rule to match has its policy applied.
  - created_at (Required, datetime)
    The timestamp when the rule was added.
  - updated_at (Required, datetime)
    The timestamp when the rule was last edited.
- advanced_snippet (Required, object)
  Used for advanced filtering at query time, with the following sub-attributes:
  - value (Required, object)
    A JSON object passed directly to the connector for advanced filtering.
  - created_at (Required, datetime)
    The timestamp when this JSON object was created.
  - updated_at (Required, datetime)
    The timestamp when this JSON object was last edited.
- validation (Required, object)
  Provides validation status for the rules, including:
  - state (Required, string)
    Indicates the validation state: "edited", "valid", or "invalid".
  - errors (Required, object)
    Contains details about any validation errors, with sub-attributes:
    
    ids (Required, string)
    The ID(s) of any rules deemed invalid.
    
    messages (Required, string)
    Messages explaining what is invalid about the rules.
draft (Required, object)
An object identical in structure to the active object, but used for drafting and editing filtering rules before they become active.

Response codesedit

200: Connector filtering field was successfully updated.
400: The connector_id was not provided or the request payload was malformed.
404 (Missing resources): No connector matching connector_id could be found.

Examplesedit

The following example updates the filtering property for the connector with ID my-connector:

response = client.connector.update_filtering(
  connector_id: 'my-connector',
  body: {
    filtering: [
      {
        active: {
          advanced_snippet: {
            created_at: '2023-11-09T15:13:08.231Z',
            updated_at: '2023-11-09T15:13:08.231Z',
            value: {}
          },
          rules: [
            {
              created_at: '2023-11-09T15:13:08.231Z',
              field: '_',
              id: 'DEFAULT',
              order: 0,
              policy: 'include',
              rule: 'regex',
              updated_at: '2023-11-09T15:13:08.231Z',
              value: '.*'
            }
          ],
          validation: {
            errors: [],
            state: 'valid'
          }
        },
        domain: 'DEFAULT',
        draft: {
          advanced_snippet: {
            created_at: '2023-11-09T15:13:08.231Z',
            updated_at: '2023-11-09T15:13:08.231Z',
            value: {}
          },
          rules: [
            {
              created_at: '2023-11-09T15:13:08.231Z',
              field: '_',
              id: 'DEFAULT',
              order: 0,
              policy: 'include',
              rule: 'regex',
              updated_at: '2023-11-09T15:13:08.231Z',
              value: '.*'
            }
          ],
          validation: {
            errors: [],
            state: 'valid'
          }
        }
      }
    ]
  }
)
puts response

PUT _connector/my-connector/_filtering
{
    "filtering": [
        {
            "active": {
                "advanced_snippet": {
                    "created_at": "2023-11-09T15:13:08.231Z",
                    "updated_at": "2023-11-09T15:13:08.231Z",
                    "value": {}
                },
                "rules": [
                    {
                        "created_at": "2023-11-09T15:13:08.231Z",
                        "field": "_",
                        "id": "DEFAULT",
                        "order": 0,
                        "policy": "include",
                        "rule": "regex",
                        "updated_at": "2023-11-09T15:13:08.231Z",
                        "value": ".*"
                    }
                ],
                "validation": {
                    "errors": [],
                    "state": "valid"
                }
            },
            "domain": "DEFAULT",
            "draft": {
                "advanced_snippet": {
                    "created_at": "2023-11-09T15:13:08.231Z",
                    "updated_at": "2023-11-09T15:13:08.231Z",
                    "value": {}
                },
                "rules": [
                    {
                        "created_at": "2023-11-09T15:13:08.231Z",
                        "field": "_",
                        "id": "DEFAULT",
                        "order": 0,
                        "policy": "include",
                        "rule": "regex",
                        "updated_at": "2023-11-09T15:13:08.231Z",
                        "value": ".*"
                    }
                ],
                "validation": {
                    "errors": [],
                    "state": "valid"
                }
            }
        }
    ]
}

{
    "result": "updated"
}

« Update connector error API Update connector index name API »