Create and update a pipeline

The create ingest pipeline API operation creates or updates an ingest pipeline. Each pipeline requires an ingest definition defining how each processor transforms your documents.

Example

  1. PUT _ingest/pipeline/12345
  2. {
  3.   "description" : "A description for your pipeline",
  4.   "processors" : [
  5.     {
  6.       "set" : {
  7.         "field": "field-name",
  8.         "value": "value"
  9.       }
  10.     }
  11.   ]
  12. }

copy

Path and HTTP methods

  1. PUT _ingest/pipeline/{id}

Request body fields

FieldRequiredTypeDescription
descriptionOptionalstringDescription of your ingest pipeline.
processorsRequiredArray of processor objectsA processor that transforms documents. Runs in the order specified. Appears in index once ran.
  1. {
  2.   "description" : "A description for your pipeline",
  3.   "processors" : [
  4.     {
  5.       "set" : {
  6.         "field": "field-name",
  7.         "value": "value"
  8.       }
  9.     }
  10.   ]
  11. }

URL parameters

All URL parameters are optional.

ParameterTypeDescription
master_timeouttimeHow long to wait for a connection to the master node.
timeouttimeHow long to wait for the request to return.

Response

  1. {
  2.   "acknowledged" : true
  3. }