Create or update a pipeline

PUT /_ingest/pipeline/{id}

Auth

Changes made using this API take effect immediately.

About ingest pipelines

Path parameters

id string required: ID of the ingest pipeline to create or update.

Query parameters

master_timeout string · default: 30s: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
timeout string · default: 30s: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
if_version number: Required version for optimistic concurrency control for pipeline updates

Request body

_meta object: Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch.
description string: Description of the ingest pipeline.
on_failure {} Processor[]: Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors.
processors {} Processor[]: Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.
version number: Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers.
deprecated boolean · default: false: Marks this ingest pipeline as deprecated. When a deprecated ingest pipeline is referenced as the default or final pipeline when creating or updating a non-deprecated index template, Elasticsearch will emit a deprecation warning.
field_access_pattern enum · default: classic: Controls how processors in this pipeline should read and write data on a document's source.; Values: classic flexible

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

PUT _ingest/pipeline/my-pipeline-id
{
  "description" : "My optional pipeline description",
  "processors" : [
    {
      "set" : {
        "description" : "My optional processor description",
        "field": "my-keyword-field",
        "value": "foo"
      }
    }
  ]
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ingest.putPipeline({
  id: "my-pipeline-id",
  description: "My optional pipeline description",
  processors: [
    {
      set: {
        description: "My optional processor description",
        field: "my-keyword-field",
        value: "foo",
      },
    },
  ],
});

Python Elasticsearch Python Client

resp = client.ingest.put_pipeline(
    id="my-pipeline-id",
    description="My optional pipeline description",
    processors=[
        {
            "set": {
                "description": "My optional processor description",
                "field": "my-keyword-field",
                "value": "foo"
            }
        }
    ],
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_ingest/pipeline/my-pipeline-id" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "My optional pipeline description",
    "processors": [
      {
        "set": {
          "description": "My optional processor description",
          "field": "my-keyword-field",
          "value": "foo"
        }
      }
    ]
  }'

Java Elasticsearch Java Client

client.ingest().putPipeline(p -> p
    .description("My optional pipeline description")
    .id("my-pipeline-id")
    .processors(pr -> pr
        .set(s -> s
            .field("my-keyword-field")
            .value(JsonData.fromJson("\"foo\""))
            .description("My optional processor description")
        )
    )
);

C# Elasticsearch .NET Client

var response = await client.Ingest
    .PutPipelineAsync(id: "my-pipeline-id", d1 => d1
        .Description("My optional pipeline description")
        .Processors(d2 => d2
            .Set(d3 => d3
                .Description("My optional processor description")
                .Field(x => x.MyKeywordField)
                .Value("foo")
            )
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->ingest()->putPipeline([
    "id" => "my-pipeline-id",
    "body" => [
        "description" => "My optional pipeline description",
        "processors" => array(
            [
                "set" => [
                    "description" => "My optional processor description",
                    "field" => "my-keyword-field",
                    "value" => "foo",
                ],
            ],
        ),
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ingest.put_pipeline(
  id: "my-pipeline-id",
  body: {
    "description": "My optional pipeline description",
    "processors": [
      {
        "set": {
          "description": "My optional processor description",
          "field": "my-keyword-field",
          "value": "foo"
        }
      }
    ]
  }
)

Response

{
  "acknowledged": false
}

Generated from the API spec

Request Console 1 / 8 languages

You can use the _meta parameter to add arbitrary metadata to a pipeline.

Console Kibana Dev Tools

PUT /_ingest/pipeline/my-pipeline-id
{
  "description" : "My optional pipeline description",
  "processors" : [
    {
      "set" : {
        "description" : "My optional processor description",
        "field": "my-keyword-field",
        "value": "foo"
      }
    }
  ],
  "_meta": {
    "reason": "set my-keyword-field to foo",
    "serialization": {
      "class": "MyPipeline",
      "id": 10
    }
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ingest.putPipeline({
  id: "my-pipeline-id",
  description: "My optional pipeline description",
  processors: [
    {
      set: {
        description: "My optional processor description",
        field: "my-keyword-field",
        value: "foo",
      },
    },
  ],
  _meta: {
    reason: "set my-keyword-field to foo",
    serialization: {
      class: "MyPipeline",
      id: 10,
    },
  },
});

Python Elasticsearch Python Client

resp = client.ingest.put_pipeline(
    id="my-pipeline-id",
    description="My optional pipeline description",
    processors=[
        {
            "set": {
                "description": "My optional processor description",
                "field": "my-keyword-field",
                "value": "foo"
            }
        }
    ],
    meta={
        "reason": "set my-keyword-field to foo",
        "serialization": {
            "class": "MyPipeline",
            "id": 10
        }
    },
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_ingest/pipeline/my-pipeline-id" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "My optional pipeline description",
    "processors": [
      {
        "set": {
          "description": "My optional processor description",
          "field": "my-keyword-field",
          "value": "foo"
        }
      }
    ],
    "_meta": {
      "reason": "set my-keyword-field to foo",
      "serialization": {
        "class": "MyPipeline",
        "id": 10
      }
    }
  }'

Java Elasticsearch Java Client

client.ingest().putPipeline(p -> p
    .meta(Map.of("serialization", JsonData.fromJson("""
{"class":"MyPipeline","id":10}
"""),"reason", JsonData.fromJson("\"set my-keyword-field to foo\"")))
    .description("My optional pipeline description")
    .id("my-pipeline-id")
    .processors(pr -> pr
        .set(s -> s
            .field("my-keyword-field")
            .value(JsonData.fromJson("\"foo\""))
            .description("My optional processor description")
        )
    )
);

C# Elasticsearch .NET Client

var response = await client.Ingest
    .PutPipelineAsync(id: "my-pipeline-id", d1 => d1
        .Description("My optional pipeline description")
        .Meta(new Dictionary<string, object>()
        {
            { "reason", "set my-keyword-field to foo" },
            { "serialization", JsonSerializer.Deserialize<JsonElement>("""
            {
              "class": "MyPipeline",
              "id": 10
            }
            """) }
        })
        .Processors(d2 => d2
            .Set(d3 => d3
                .Description("My optional processor description")
                .Field(x => x.MyKeywordField)
                .Value("foo")
            )
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->ingest()->putPipeline([
    "id" => "my-pipeline-id",
    "body" => [
        "description" => "My optional pipeline description",
        "processors" => array(
            [
                "set" => [
                    "description" => "My optional processor description",
                    "field" => "my-keyword-field",
                    "value" => "foo",
                ],
            ],
        ),
        "_meta" => [
            "reason" => "set my-keyword-field to foo",
            "serialization" => [
                "class" => "MyPipeline",
                "id" => 10,
            ],
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ingest.put_pipeline(
  id: "my-pipeline-id",
  body: {
    "description": "My optional pipeline description",
    "processors": [
      {
        "set": {
          "description": "My optional processor description",
          "field": "my-keyword-field",
          "value": "foo"
        }
      }
    ],
    "_meta": {
      "reason": "set my-keyword-field to foo",
      "serialization": {
        "class": "MyPipeline",
        "id": 10
      }
    }
  }
)

Response

{
  "acknowledged": false
}

Generated from the API spec