Elastic Documents API
Index, update, retrieve, and delete documents.
Elastic Documents API is one of 12 APIs that Elastic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 3 operations across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against a single base URL, https://api.elastic-cloud.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Elastic Documents API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (apiKeyAuth).
By default, every request must be authenticated.
apiKeyAuth— ApiKey
Paths & Operations 3
Across 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Index, update, retrieve, and delete documents.
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Document (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic 11
Other APIs Elastic publishes across the network.