Elastic Documents API

Index, update, retrieve, and delete documents.

Operations 3

GET /{index}/_doc/{id} Get a document by ID #
PUT /{index}/_doc/{id} Index a document with explicit ID #
DELETE /{index}/_doc/{id} Delete a document by ID #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/elastic-documents-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

elastic-documents-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Elasticsearch REST Documents API
  description: REST APIs for the Elasticsearch search and analytics engine. Provides operations for indexing documents, searching, managing indices, mappings, aliases, security, snapshots, and cluster administration. Used both by the Kibana UI and directly by client applications to ingest, search, and analyze data at scale.
  version: '9.0'
  contact:
    name: Elastic
    url: https://www.elastic.co
  license:
    name: Elastic License 2.0
    url: https://www.elastic.co/licensing/elastic-license
servers:
- url: https://{deployment}.es.{region}.cloud.es.io:9243
  description: Elastic Cloud deployment
  variables:
    deployment:
      default: my-deployment
      description: Deployment identifier
    region:
      default: us-east-1
      description: Cloud region
- url: http://localhost:9200
  description: Local Elasticsearch
security:
- apiKeyAuth: []
- basicAuth: []
tags:
- name: Documents
  description: Index, update, retrieve, and delete documents.
paths:
  /{index}/_doc/{id}:
    get:
      operationId: getDocument
      summary: Get a document by ID
      tags:
      - Documents
      parameters:
      - name: index
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Document response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
        '404':
          description: Not found
    put:
      operationId: indexDocument
      summary: Index a document with explicit ID
      tags:
      - Documents
      parameters:
      - name: index
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '201':
          description: Created
        '200':
          description: Updated
    delete:
      operationId: deleteDocument
      summary: Delete a document by ID
      tags:
      - Documents
      parameters:
      - name: index
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Deleted
        '404':
          description: Not found
components:
  schemas:
    Document:
      type: object
      properties:
        _index:
          type: string
        _id:
          type: string
        _score:
          type: number
          nullable: true
        _source:
          type: object
          additionalProperties: true
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: ApiKey base64-encoded id:api_key
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: Elasticsearch REST API Reference
  url: https://www.elastic.co/docs/api/doc/elasticsearch