Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elasticsearch Document API

The Document API from Elasticsearch — 2 operation(s) for document.

Elasticsearch Document API is one of 5 APIs that Elasticsearch publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Document. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths. It is described by OpenAPI 3.1.0, at version 8.x.

Requests are made against a single base URL, https://{host}:{port}.

4 operations 2 paths 0 schemas 1 DELETE1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
8.x
Base URL
https://localhost:9200
Authentication
HTTP Basic, API Key
Contact
Resource Areas
1

Authentication & Security 2

Elasticsearch Document API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as Authorization (apiKeyAuth). By default, every request must be authenticated.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Document 4
PUT
/{index}/_doc/{id}
Index a document
indexDocument 2 params body → 200
GET
/{index}/_doc/{id}
Get document
getDocument 2 params → 200
DELETE
/{index}/_doc/{id}
Delete a document
deleteDocument 2 params → 200
POST
/_bulk
Bulk operations
bulk body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-search-document-api-openapi.yml Raw ↑

Other APIs Elasticsearch publishes across the network.

Elasticsearch Cat API
Elasticsearch Cluster API
Elasticsearch Index API
Elasticsearch Search API