Create or update a pipeline

PUT /_ingest/pipeline/{id}

Changes made using this API take effect immediately.

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Request body

Response

application/json

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

No example

Request Console 1 / 2 languages

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

Console Kibana Dev Tools

PUT /_ingest/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
    }
  }
}

Generated from the API spec

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_ingest/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
      }
    }
  }'

Generated from the API spec

Response

No example

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body