Elastic Stack (ELK Stack) Index API

openapi: 3.1.0
info:
  title: Elasticsearch REST Cat Index 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: Index
paths:
  /{index}:
    put:
      summary: Create index
      operationId: createIndex
      tags:
      - Index
      parameters:
      - $ref: '#/components/parameters/IndexName'
      responses:
        '200':
          description: Index created
    delete:
      summary: Delete index
      operationId: deleteIndex
      tags:
      - Index
      parameters:
      - $ref: '#/components/parameters/IndexName'
      responses:
        '200':
          description: Index deleted
  /{index}/_mapping:
    get:
      summary: Get index mappings
      operationId: getIndexMapping
      tags:
      - Index
      parameters:
      - $ref: '#/components/parameters/IndexName'
      responses:
        '200':
          description: Index mappings
  /{index}/_settings:
    put:
      summary: Update index settings
      operationId: updateIndexSettings
      tags:
      - Index
      parameters:
      - $ref: '#/components/parameters/IndexName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Settings updated
components:
  parameters:
    IndexName:
      name: index
      in: path
      required: true
      schema:
        type: string
      description: Index name
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: ApiKey <base64-encoded-id:api_key>