Simulate a pipeline

Simulates an ingest pipeline with any example documents you specify.

Example

  1. POST /_ingest/pipeline/35678/_simulate
  2. {
  3.   "docs": [
  4.     {
  5.       "_index": "index",
  6.       "_id": "id",
  7.       "_source": {
  8.         "location": "document-name"
  9.       }
  10.     },
  11.     {
  12.       "_index": "index",
  13.       "_id": "id",
  14.       "_source": {
  15.         "location": "document-name"
  16.       }
  17.     }
  18.   ]
  19. }

Path and HTTP methods

Simulate the last ingest pipeline created.

  1. GET _ingest/pipeline/_simulate
  2. POST _ingest/pipeline/_simulate

Simulate a single pipeline based on the pipeline’s ID.

  1. GET _ingest/pipeline/{id}/_simulate
  2. POST _ingest/pipeline/{id}/_simulate

URL parameters

All URL parameters are optional.

ParameterTypeDescription
verbosebooleanVerbose mode. Display data output for each processor in executed pipeline.

Request body fields

FieldRequiredTypeDescription
pipelineOptionalobjectThe pipeline you want to simulate. When included without the pipeline {id} inside the request path, the response simulates the last pipeline created.
docsRequiredarray of objectsThe documents you want to use to test the pipeline.

The docs field can include the following subfields:

FieldRequiredTypeDescription
idOptionalstringAn optional identifier for the document. The identifier cannot be used elsewhere in the index.
indexOptionalstringThe index where the document’s transformed data appears.
sourceRequiredobjectThe document’s JSON body.

Response

Responses vary based on which path and HTTP method you choose.

Specify pipeline in request body

  1. {
  2.   "docs" : [
  3.     {
  4.       "doc" : {
  5.         "_index" : "index",
  6.         "_type" : "_doc",
  7.         "_id" : "id",
  8.         "_source" : {
  9.           "location" : "new-new",
  10.           "field2" : "_value"
  11.         },
  12.         "_ingest" : {
  13.           "timestamp" : "2022-02-07T18:47:57.479230835Z"
  14.         }
  15.       }
  16.     },
  17.     {
  18.       "doc" : {
  19.         "_index" : "index",
  20.         "_type" : "_doc",
  21.         "_id" : "id",
  22.         "_source" : {
  23.           "location" : "new-new",
  24.           "field2" : "_value"
  25.         },
  26.         "_ingest" : {
  27.           "timestamp" : "2022-02-07T18:47:57.47933496Z"
  28.         }
  29.       }
  30.     }
  31.   ]
  32. }

Specify pipeline ID inside HTTP path

  1. {
  2.   "docs" : [
  3.     {
  4.       "doc" : {
  5.         "_index" : "index",
  6.         "_type" : "_doc",
  7.         "_id" : "id",
  8.         "_source" : {
  9.           "field-name" : "value",
  10.           "location" : "document-name"
  11.         },
  12.         "_ingest" : {
  13.           "timestamp" : "2022-02-03T21:47:05.382744877Z"
  14.         }
  15.       }
  16.     },
  17.     {
  18.       "doc" : {
  19.         "_index" : "index",
  20.         "_type" : "_doc",
  21.         "_id" : "id",
  22.         "_source" : {
  23.           "field-name" : "value",
  24.           "location" : "document-name"
  25.         },
  26.         "_ingest" : {
  27.           "timestamp" : "2022-02-03T21:47:05.382803544Z"
  28.         }
  29.       }
  30.     }
  31.   ]
  32. }

Receive verbose response

With the verbose parameter set to true, the response shows how each processor transforms the specified document.

  1. {
  2.   "docs" : [
  3.     {
  4.       "processor_results" : [
  5.         {
  6.           "processor_type" : "set",
  7.           "status" : "success",
  8.           "doc" : {
  9.             "_index" : "index",
  10.             "_type" : "_doc",
  11.             "_id" : "id",
  12.             "_source" : {
  13.               "field-name" : "value",
  14.               "location" : "document-name"
  15.             },
  16.             "_ingest" : {
  17.               "pipeline" : "35678",
  18.               "timestamp" : "2022-02-03T21:45:09.414049004Z"
  19.             }
  20.           }
  21.         }
  22.       ]
  23.     },
  24.     {
  25.       "processor_results" : [
  26.         {
  27.           "processor_type" : "set",
  28.           "status" : "success",
  29.           "doc" : {
  30.             "_index" : "index",
  31.             "_type" : "_doc",
  32.             "_id" : "id",
  33.             "_source" : {
  34.               "field-name" : "value",
  35.               "location" : "document-name"
  36.             },
  37.             "_ingest" : {
  38.               "pipeline" : "35678",
  39.               "timestamp" : "2022-02-03T21:45:09.414093212Z"
  40.             }
  41.           }
  42.         }
  43.       ]
  44.     }
  45.   ]
  46. }