IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Update connector name and description API Update connector scheduling API »
Elastic Docs ›Elasticsearch Guide [8.14] ›REST APIs ›Connector APIs

Update connector pipeline API

edit

Update connector pipeline API

edit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Updates the pipeline configuration of a connector.

When you create a new connector, the configuration of an ingest pipeline is populated with default settings.

To get started with Connector APIs, check out the tutorial.

Request

edit

PUT _connector/<connector_id>/_pipeline

Prerequisites

edit
  • To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
  • The connector_id parameter should reference an existing connector.

Path parameters

edit
<connector_id>
(Required, string)

Request body

edit
pipeline
(Required, object) The pipeline configuration of the connector. The pipeline determines how data is processed during ingestion into Elasticsearch.

Pipeline configuration must include the following attributes:

  • extract_binary_content (Required, boolean) A flag indicating whether to extract binary content during ingestion.
  • name (Required, string) The name of the ingest pipeline.
  • reduce_whitespace (Required, boolean) A flag indicating whether to reduce extra whitespace in the ingested content.
  • run_ml_inference (Required, boolean) A flag indicating whether to run machine learning inference on the ingested content.

Response codes

edit
200
Connector pipeline 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.

Examples

edit

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

response = client.connector.update_pipeline(
  connector_id: 'my-connector',
  body: {
    pipeline: {
      extract_binary_content: true,
      name: 'my-connector-pipeline',
      reduce_whitespace: true,
      run_ml_inference: true
    }
  }
)
puts response
PUT _connector/my-connector/_pipeline
{
    "pipeline": {
        "extract_binary_content": true,
        "name": "my-connector-pipeline",
        "reduce_whitespace": true,
        "run_ml_inference": true
    }
}
{
    "result": "updated"
}
« Update connector name and description API Update connector scheduling API »