Elastic Stack (ELK Stack) Ingest API

The Ingest API from Elastic Stack (ELK Stack) — 1 operation(s) for ingest.

OpenAPI Specification

elk-stack-ingest-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Elasticsearch REST Cat Ingest API
  description: 'The Elasticsearch REST API exposes the core operations of the distributed search and analytics engine at the heart of the Elastic Stack. It allows clients to manage indices, ingest and retrieve documents, run search and aggregation queries, inspect cluster and node health, and operate snapshots and ingest pipelines.

    '
  version: 1.0.0
  contact:
    name: Elastic
    url: https://www.elastic.co
servers:
- url: http://localhost:9200
  description: Default local Elasticsearch endpoint
- url: https://{host}:{port}
  description: Self-hosted or Elastic Cloud cluster endpoint
  variables:
    host:
      default: localhost
    port:
      default: '9200'
security:
- basicAuth: []
- apiKeyAuth: []
tags:
- name: Ingest
paths:
  /_ingest/pipeline/{id}/_simulate:
    post:
      summary: Simulate ingest pipeline
      operationId: simulateIngestPipeline
      tags:
      - Ingest
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Simulation result
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: ApiKey <base64-encoded-id:api_key>