You're viewing version 3.7 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
Ingest APIs
Introduced 1.0
Ingest APIs are a valuable tool for loading data into a system. Ingest APIs work together with ingest pipelines and ingest processors to process or transform data from a variety of sources and in a variety of formats.
Ingest pipeline APIs
Simplify, secure, and scale your OpenSearch data ingestion with the following APIs:
- Create pipeline: Use this API to create or update a pipeline configuration.
- Get pipeline: Use this API to retrieve a pipeline configuration.
- Simulate pipeline: Use this pipeline to test a pipeline configuration.
- Access data in a pipeline: Use this API to access data in a pipeline.
- Delete pipeline: Use this API to delete a pipeline configuration.
Required permissions
If you use the Security plugin, make sure you have the appropriate permissions. The following permissions are required for this API:
cluster:admin/ingest/pipeline/get: Required for getting pipelinescluster:admin/ingest/pipeline/put: Required for creating or updating pipelinescluster:admin/ingest/pipeline/delete: Required for deleting pipelines