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

Elastic Search API

Search and query operations across indices.

Elastic Search API is one of 12 APIs that Elastic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 2 operations across 2 paths, and defines 2 schemas. 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.

2 operations 2 paths 2 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.elastic-cloud.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Elastic Search 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 2

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

Search 2

Search and query operations across indices.

GET
/_search
Search across all indices
searchAllIndices 2 params → 200
GET
/{index}/_search
Search a specific index
searchIndex 2 params → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Document (4 properties), SearchResponse (3 properties). Each schema is shown below with its type and property counts.

SearchResponse
object
3 properties
Document
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-search-api-openapi.yml Raw ↑

Other APIs Elastic publishes across the network.

Elastic Account API
Elastic Cluster API
Elastic DataViews API
Elastic Deployments API
Elastic Documents API
Elastic Indices API
Elastic SavedObjects API
Elastic Security API
Elastic Spaces API
Elastic Status API
Elastic TrafficFilters API