# Simulate a pipeline


**POST /_ingest/pipeline/{id}/_simulate**

**All methods and paths for this operation:**

<div>
                      <span class="operation-verb get">GET</span>
                      <span class="operation-path">/_ingest/pipeline/_simulate</span>
                      </div>
                    <div>
                      <span class="operation-verb post">POST</span>
                      <span class="operation-path">/_ingest/pipeline/_simulate</span>
                      </div>
                    <div>
                      <span class="operation-verb get">GET</span>
                      <span class="operation-path">/_ingest/pipeline/{id}/_simulate</span>
                      </div>
                    <div>
                      <span class="operation-verb post">POST</span>
                      <span class="operation-path">/_ingest/pipeline/{id}/_simulate</span>
                      </div>
                    

Run an ingest pipeline against a set of provided documents.
You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.

## Required authorization

* Cluster privileges: `read_pipeline`



## Servers
- http://api.example.com: http://api.example.com ()


## Authentication methods
- Api key auth


## Parameters

### Path parameters
- **id** (string)
  The pipeline to test.
  If you don't specify a `pipeline` in the request body, this parameter is required.

### Query parameters
- **verbose** (boolean)
  If `true`, the response includes output data for each processor in the executed pipeline.

### Body: application/json (object)

- **docs** (array[object])
  Sample documents to test in the pipeline.
- **pipeline** (object)
  The pipeline to test.
  If you don't specify the `pipeline` request path parameter, this parameter is required.
  If you specify both this and the request path parameter, the API only uses the request path parameter.


## Responses
### 200


#### Body: application/json (object)
- **docs** (array[object])



[Powered by Bump.sh](https://bump.sh)