Elastic Stack (ELK Stack) Document API
The document API from Elastic Stack (ELK Stack) — 19 operation(s) for document.
Elastic Stack (ELK Stack) Document API is one of 133 APIs that Elastic Stack 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, API documentation, and an API reference.
This API exposes 33 operations across 19 paths, and defines 480 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: http://localhost:9200, https://{host}:{port}.
33 operations
19 paths
480 schemas
1 DELETE8 GET2 HEAD18 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Elastic Stack (ELK Stack) 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).
apiKeyAuth— ApiKey
Paths & Operations 33
Across 19 paths, the API surfaces 33 operations — 1 DELETE, 8 GET, 2 HEAD, 18 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Document 33
PUT
/_bulk
Bulk index or delete documents
POST
/_bulk
Bulk index or delete documents
PUT
/{index}/_bulk
Bulk index or delete documents
POST
/{index}/_bulk
Bulk index or delete documents
PUT
/{index}/_create/{id}
Create a new document in the index
POST
/{index}/_create/{id}
Create a new document in the index
GET
/{index}/_doc/{id}
Get a document by its ID
PUT
/{index}/_doc/{id}
Create or update a document in an index
POST
/{index}/_doc/{id}
Create or update a document in an index
DELETE
/{index}/_doc/{id}
Delete a document
HEAD
/{index}/_doc/{id}
Check a document
POST
/{index}/_delete_by_query
Delete documents
POST
/_delete_by_query/{task_id}/_rethrottle
Throttle a delete by query operation
GET
/{index}/_source/{id}
Get a document's source
HEAD
/{index}/_source/{id}
Check for a document source
POST
/{index}/_doc
Create or update a document in an index
POST
/_reindex
Reindex documents
GET
/_mget
Get multiple documents
POST
/_mget
Get multiple documents
GET
/{index}/_mget
Get multiple documents
POST
/{index}/_mget
Get multiple documents
GET
/_mtermvectors
Get multiple term vectors
POST
/_mtermvectors
Get multiple term vectors
GET
/{index}/_mtermvectors
Get multiple term vectors
POST
/{index}/_mtermvectors
Get multiple term vectors
POST
/_reindex/{task_id}/_rethrottle
Throttle a reindex operation
GET
/{index}/_termvectors/{id}
Get term vector information
POST
/{index}/_termvectors/{id}
Get term vector information
GET
/{index}/_termvectors
Get term vector information
POST
/{index}/_termvectors
Get term vector information
POST
/{index}/_update/{id}
Update a document
POST
/{index}/_update_by_query
Update documents
POST
/_update_by_query/{task_id}/_rethrottle
Throttle an update by query operation
Schemas 480
The contract defines 480 schemas that model the data the API accepts and returns. The most detailed are _types.query_dsl.QueryContainer (61 properties), _global.search._types.SearchRequestBody (34 properties), _global.search._types.HighlightBase (21 properties), _global.search._types.InnerHits (17 properties). Each schema is shown below with its type and property counts.
_types.GeoHashLocation
object
1 property
1 required
_types.aggregations.IpRangeAggregationRange
object
3 properties
_types.query_dsl.PinnedQuery
_types.aggregations.SamplerAggregation
_types.GeoLocation
A latitude/longitude as a 2 dimensional point. It can be represented in various ways: - as a {lat, long} object - as a geo hash value - as a [lon, lat] array -…
_global.search._types.FieldCollapse
object
4 properties
1 required
_types.LinearRetriever
_global.reindex.Source
object
8 properties
1 required
_types.SlicesCalculation
string
_types.ScriptSortType
string
_types.aggregations.SignificantTermsAggregation
_types.query_dsl.ConstantScoreQuery
_types.aggregations.BucketPathAggregation
ml._types.RegressionInferenceOptions
object
2 properties
_types.SequenceNumber
number
_types.Distance
string
_types.Host
string
_types.query_dsl.SimpleQueryStringFlag
string
_types.KnnSearch
object
12 properties
1 required
_types.Field
string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
_types.aggregations.CardinalityAggregation
_global.bulk.IndexOperation
_types.aggregations.RangeAggregation
_types.SortOptions
object
4 properties
_types.aggregations.Missing
_types.GeoDistanceType
string
_types.aggregations.TopMetricsAggregation
_types.aggregations.MutualInformationHeuristic
object
2 properties
_types.query_dsl.IntervalsFilter
object
9 properties
_types.query_dsl.DecayFunctionBase
object
1 property
_types.query_dsl.FunctionScoreMode
string
_types.aggregations.BucketKsAggregation
A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred to as a "K-S test" from now on) against a provided distribution, a…
_types.aggregations.GeoCentroidAggregation
_types.aggregations.TermsPartition
object
2 properties
2 required
_types.query_dsl.GeoExecution
string
_types.BulkIndexByScrollFailure
object
4 properties
4 required
_types.KnnEmbeddingInput
Knn embedding input. Either a string, an object or array of objects
_types.aggregations.CustomCategorizeTextAnalyzer
object
3 properties
_types.query_dsl.RangeQueryBasedouble
_types.aggregations.CartesianCentroidAggregation
_types.MultiTermQueryRewrite
string
_types.query_dsl.SpanNotQuery
_types.query_dsl.FieldAndFormat
object
A reference to a field with formatting instructions on how to return the value
3 properties
1 required
_types.RRFRetriever
_types.Indices
_global.mtermvectors.Operation
object
13 properties
_types.mapping.RuntimeFieldType
string
_global.update.UpdateWriteResponseBase
_types.TopRightBottomLeftGeoBounds
object
2 properties
2 required
_global.search._types.Highlight
_types.aggregations.FiltersAggregation
_types.aggregations.TestPopulation
object
3 properties
1 required
_types.aggregations.RateMode
string
_global.search._types.RescoreQuery
object
4 properties
1 required
_types.aggregations.IpPrefixAggregation
_types.query_dsl.RangeQueryBasestring
_types.mapping.RuntimeFieldFetchFields
object
2 properties
1 required
_types.aggregations.BucketSortAggregation
_types.RescorerRetriever
_types.query_dsl.DecayFunctionBasedoubledouble
object
1 property
_types.TopLeftBottomRightGeoBounds
object
2 properties
2 required
_types.aggregations.GeoBoundsAggregation
_types.aggregations.AggregateOrder
_types.aggregations.TDigestExecutionHint
string
_types.query_dsl.UntypedDistanceFeatureQuery
_spec_utils.PipeSeparatedFlagsSimpleQueryStringFlag
A set of flags that can be represented as a single enum value or a set of values that are encoded as a pipe-separated string Depending on the target language,…
_global.bulk.DeleteOperation
_types.VersionType
string
_types.aggregations.EwmaModelSettings
object
1 property
_types.aggregations.PValueHeuristic
object
2 properties
_types.TransportAddress
string
_global.search._types.HighlighterOrder
string
_types.query_dsl.IntervalsAllOf
object
4 properties
1 required
_types.query_dsl.SimpleQueryStringQuery
_types.query_dsl.RuleQuery
_types.aggregations.MissingAggregation
_types.query_dsl.TermRangeQuery
_types.query_dsl.GeoDistanceFeatureQuery
_types.query_dsl.RangeQuery
_types.aggregations.MatrixStatsAggregation
_global.reindex_rethrottle.ReindexTask
object
11 properties
11 required
_types.aggregations.MovingAverageAggregationBase
_types.UnitNanos
number
Time unit for nanoseconds
inference._types.EmbeddingContentFormat
string
_types.GeoTilePrecision
number
_types.Username
string
_types.aggregations.MultiTermLookup
_types.query_dsl.DecayFunction
_types.query_dsl.ParentIdQuery
_types.query_dsl.WeightedTokensQuery
_types.aggregations.BucketScriptAggregation
_types.query_dsl.FunctionScoreContainer
_types.aggregations.CalendarInterval
string
_types.aggregations.FrequentItemSetsAggregation
object
5 properties
1 required
_types.aggregations.FrequentItemSetsField
object
3 properties
1 required
_types.PinnedRetriever
_types.aggregations.CategorizeTextAnalyzer
_types.query_dsl.WrapperQuery
_types.query_dsl.SpanGapQuery
object
Can only be used as a clause in a spannear query.
_types.query_dsl.QueryStringQuery
_types.RelationName
string
_types.aggregations.MatrixAggregation
_types.query_dsl.CombinedFieldsOperator
string
_types.Ids
_types.query_dsl.GeoGridQuery
_types.aggregations.CompositeAggregateKey
object
_types.query_dsl.SpanMultiTermQuery
_types.QueryVector
array
_types.GeoDistanceSort
object
6 properties
_types.aggregations.HoltLinearModelSettings
object
2 properties
_types.query_dsl.IntervalsWildcard
object
3 properties
1 required
_types.Duration
A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indica…
_types.query_dsl.GeoDecayFunction
_types.aggregations.CumulativeCardinalityAggregation
_types.HttpHeaders
object
_types.query_dsl.MoreLikeThisQuery
_types.WktGeoBounds
object
1 property
1 required
_types.DurationLarge
string
A date histogram interval. Similar to Duration with additional units: w (week), M (month), q (quarter) and y (year)
_types.GeoHashPrecision
A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m".
_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance
_types.aggregations.NormalizeMethod
string
_types.query_dsl.FieldValueFactorModifier
string
_types.aggregations.DiversifiedSamplerAggregation
_types.aggregations.ExtendedBoundsdouble
object
2 properties
_types.query_dsl.MatchPhrasePrefixQuery
_types.Ip
string
_global.search._types.HighlighterFragmenter
string
_types.aggregations.TopMetricsValue
object
1 property
1 required
_types.query_dsl.FuzzyQuery
_global.search._types.SourceConfigParam
Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered. Used as a query parameter along with the sourceincludes and so…
_types.aggregations.CardinalityExecutionMode
string
_types.query_dsl.TextExpansionQuery
_global.search._types.PointInTimeReference
object
2 properties
1 required
_types.query_dsl.SpanTermQuery
_types.SortResults
array
_types.query_dsl.ScriptQuery
_types.aggregations.PipelineAggregationBase
_types.query_dsl.UntypedDecayFunction
_global.mget.ResponseItem
_types.query_dsl.RegexpQuery
_types.aggregations.CompositeHistogramAggregation
_types.InnerRetriever
object
3 properties
3 required
_types.aggregations.WeightedAverageValue
object
3 properties
_types.RRFRetrieverComponent
object
Wraps a retriever with an optional weight for RRF scoring.
2 properties
1 required
_types.aggregations.MissingOrder
string
_types.aggregations.SignificantTextAggregation
_types.aggregations.ChiSquareHeuristic
object
2 properties
2 required
_types.aggregations.BucketCorrelationFunctionCountCorrelation
object
1 property
1 required
_types.aggregations.ExtendedBoundsFieldDateMath
object
2 properties
_types.TaskId
string
_types.Embedding
object
3 properties
1 required
_types.query_dsl.BoostingQuery
_types.aggregations.TimeSeriesAggregation
_types.aggregations.TermsAggregation
_types.aggregations.MaxAggregation
_types.query_dsl.IntervalsAnyOf
object
2 properties
1 required
_global.termvectors.Term
object
5 properties
1 required
_types.ScriptSource
_types.query_dsl.GeoShapeQuery
_types.query_dsl.FunctionBoostMode
string
_types.Fields
_types.aggregations.SamplerAggregationExecutionHint
string
_types.query_dsl.RangeQueryBaseDateMath
_types.query_dsl.TypeQuery
_types.aggregations.CartesianBoundsAggregation
_types.WaitForActiveShards
_types.Password
string
_types.query_dsl.IntervalsRegexp
object
3 properties
1 required
_types.aggregations.CompositeAggregationSource
object
4 properties
_types.query_dsl.SpanFieldMaskingQuery
_types.query_dsl.CommonTermsQuery
_types.VersionNumber
number
_types.aggregations.StatsAggregation
_types.query_dsl.UntypedRangeQuery
_types.DateMath
string
_types.mapping.CompositeSubField
object
1 property
1 required
_types.aggregations.DerivativeAggregation
_types.query_dsl.MatchQuery
_global.termvectors.Token
object
4 properties
1 required
_types.aggregations.TermsExclude
_types.aggregations.CompositeTermsAggregation
_types.aggregations.BucketSelectorAggregation
_types.NodeRoles
array
_types.query_dsl.SpanContainingQuery
_types.query_dsl.CombinedFieldsQuery
_types.WaitForActiveShardOptions
string
_types.aggregations.ChildrenAggregation
_types.query_dsl.RangeRelation
string
_types.ScriptField
object
2 properties
1 required
_types.query_dsl.MatchBoolPrefixQuery
_types.query_dsl.GeoBoundingBoxQuery
_types.GeoHexCell
string
A map hex cell (H3) reference
_types.aggregations.SerialDifferencingAggregation
_types.aggregations.GeoDistanceAggregation
_types.aggregations.ExtendedStatsAggregation
_types.aggregations.RareTermsAggregation
_types.Name
string
_types.aggregations.AverageBucketAggregation
_types.aggregations.MovingAverageAggregation
_global.reindex_rethrottle.ParentReindexTask
_types.query_dsl.QueryBase
object
2 properties
_types.aggregations.MinimumInterval
string
_types.aggregations.GoogleNormalizedDistanceHeuristic
object
1 property
_types.aggregations.AdjacencyMatrixAggregation
_types.query_dsl.IntervalsFuzzy
object
6 properties
1 required
_types.query_dsl.ChildScoreMode
string
_types.LookupQueryVectorBuilder
object
4 properties
3 required
_types.query_dsl.SpanQuery
object
10 properties
_types.aggregations.CompositeAggregation
_types.RescoreVector
object
1 property
1 required
_types.aggregations.MaxBucketAggregation
_types.query_dsl.WildcardQuery
_types.aggregations.CumulativeSumAggregation
_types.aggregations.SumAggregation
_types.WriteResponseBase
object
9 properties
5 required
_types.uint
number
_types.analysis.StopWordLanguage
string
_types.aggregations.PercentageScoreHeuristic
object
_types.query_dsl.PrefixQuery
_types.IndexName
string
tasks._types.GroupBy
string
_global.search._types.InnerHits
object
17 properties
_types.query_dsl.SpanWithinQuery
_types.aggregations.MedianAbsoluteDeviationAggregation
_types.query_dsl.SpanOrQuery
_types.mapping.OnScriptError
string
_types.aggregations.MetricAggregationBase
object
3 properties
_global.search._types.HighlighterTagsSchema
string
_types.aggregations.BucketCorrelationFunction
object
1 property
1 required
_spec_utils.BaseNode
object
6 properties
5 required
_global.bulk.OperationBase
object
7 properties
_global.search._types.Rescore
_global.search._types.HighlighterEncoder
string
_types.ExpandWildcards
_types.query_dsl.RankFeatureFunctionLinear
_types.SortMode
string
_global.search._types.SourceConfig
Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
_global.search._types.HighlightField
_types.query_dsl.RandomScoreFunction
object
2 properties
_types.aggregations.NormalizeAggregation
_types.query_dsl.TermsSetQuery
_types.ScoreNormalizer
string
_types.query_dsl.DistanceFeatureQueryBaseDateMathDuration
_types.aggregations.TopHitsAggregation
_types.query_dsl.ShapeQuery
_types.aggregations.HdrMethod
object
1 property
_types.aggregations.TTestAggregation
_types.KnnQuery
_types.query_dsl.IdsQuery
_types.LatLonGeoLocation
object
2 properties
2 required
_types.aggregations.MinBucketAggregation
_types.query_dsl.DateDecayFunction
_types.GeoHash
string
_types.mapping.RuntimeFields
object
_global.search._types.SourceFilter
object
3 properties
_types.aggregations.RateAggregation
_global.reindex_rethrottle.ReindexNode
_types.aggregations.CompositeAggregationBase
object
6 properties
_types.aggregations.TermsAggregationCollectMode
string
_types.NodeRole
string
_types.GeoBounds
A geo bounding box. It can be represented in various ways: - as 4 top/bottom/left/right coordinates - as 2 topleft / bottomright points - as 2 topright / botto…
_types.aggregations.NestedAggregation
_types.query_dsl.TermsQuery
_types.RankContainer
object
1 property
_types.aggregations.HoltWintersType
string
_types.query_dsl.PercolateQuery
_types.query_dsl.MultiMatchQuery
_global.bulk.WriteOperation
_types.Retries
object
2 properties
2 required
_types.InlineGet
object
6 properties
1 required
_types.aggregations.MovingFunctionAggregation
_types.aggregations.TermsInclude
_global.search._types.LearningToRank
object
2 properties
1 required
_types.aggregations.GeoTileGridAggregation
_types.Refresh
string
_types.CoordsGeoBounds
object
4 properties
4 required
tasks._types.ParentTaskInfo
_types.DiversifyRetrieverTypes
string
_types.QueryVectorBuilder
object
3 properties
_types.aggregations.PercentileRanksAggregation
_global.reindex_rethrottle.ParentReindexStatus
object
16 properties
9 required
_types.query_dsl.MatchPhraseQuery
_types.InferenceStringGroup
_types.SortCombinations
_types.query_dsl.RangeQueryBaselong
_types.aggregations.SumBucketAggregation
tasks._types.TaskInfo
object
16 properties
8 required
_types.ErrorCause
object
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on th…
6 properties
1 required
_global.search._types.ScoreMode
string
_types.aggregations.ValueCountAggregation
_types.aggregations.GapPolicy
string
_types.aggregations.ValueType
string
_types.query_dsl.DisMaxQuery
_types.query_dsl.GeoValidationMethod
string
_global.search._types.ScriptRescore
object
1 property
1 required
_types.aggregations.GeoLineSort
object
1 property
1 required
_types.aggregations.SimpleMovingAverageAggregation
_types.InferenceString
object
3 properties
2 required
tasks._types.TaskListResponseBase
object
4 properties
_global.bulk.UpdateAction
object
The source line that must follow an update action line. It specifies the partial document, script, or upsert options to apply, plus optional update settings.
7 properties
_types.DateFormat
string
_global.termvectors.TermVector
object
2 properties
1 required
_types.UnitMillis
number
Time unit for milliseconds
_types.SortOrder
string
_global.bulk.ResponseItem
object
12 properties
2 required
_types.ScriptLanguage
_global.search._types.Suggester
object
1 property
ml._types.ClassificationInferenceOptions
object
5 properties
_types.RuleRetriever
_global.bulk.CreateOperation
_types.DurationValueUnitMillis
_types.query_dsl.TermQuery
_types.aggregations.GeoLinePoint
object
1 property
1 required
_types.query_dsl.RankFeatureFunction
object
_types.query_dsl.IntervalsMatch
object
6 properties
1 required
_types.query_dsl.Like
Text that we want similar documents for or a lookup to a document's field for the text.
_types.aggregations.ChangePointAggregation
_types.RRFRetrieverEntry
Either a direct RetrieverContainer (backward compatible) or an RRFRetrieverComponent with weight.
_types.aggregations.MinAggregation
_types.aggregations.TTestType
string
_types.RetrieverBase
object
3 properties
_types.ShardStatistics
object
5 properties
3 required
_types.aggregations.MultiTermsAggregation
_types.query_dsl.DecayFunctionBaseDateMathDuration
object
1 property
_types.aggregations.MovingPercentilesAggregation
_types.query_dsl.MatchNoneQuery
_types.aggregations.CompositeGeoTileGridAggregation
_global.mget.Operation
object
7 properties
1 required
_types.query_dsl.IntervalsQuery
_global.mtermvectors.TermVectorsResult
object
7 properties
1 required
_types.StandardRetriever
_types.query_dsl.DistanceFeatureQueryBase
_types.query_dsl.RankFeatureQuery
_types.DurationValueUnitNanos
_types.query_dsl.ScriptScoreQuery
_types.Conflicts
string
_types.aggregations.GeoLineAggregation
object
5 properties
1 required
_global.reindex_rethrottle.ReindexTasks
_types.query_dsl.NumericDecayFunction
_global.reindex.Destination
object
5 properties
1 required
_types.aggregations.AverageAggregation
_types.query_dsl.SparseVectorQuery
_types.OpType
string
_types.aggregations.HistogramAggregation
_types.query_dsl.Operator
string
_types.query_dsl.LongNumberRangeQuery
_types.SlicedScroll
object
3 properties
2 required
_types.aggregations.BucketsQueryContainer
Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for the different buckets, the result is a dictionary.
_global.search._types.HighlighterType
_global.bulk.UpdateOperation
_types.aggregations.GeohexGridAggregation
_global.termvectors.Filter
object
7 properties
_types.aggregations.DateHistogramAggregation
_types.GeoTile
string
A map tile reference, represented as {zoom}/{x}/{y}
_types.InlineGetDictUserDefined
object
6 properties
1 required
_types.query_dsl.ZeroTermsQuery
string
_types.aggregations.PercentilesAggregation
_types.ReindexStatus
object
15 properties
9 required
_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator
object
3 properties
2 required
_types.query_dsl.RankFeatureFunctionSigmoid
_types.aggregations.BucketAggregationBase
Base type for bucket aggregations. These aggregations also accept sub-aggregations.
_types.aggregations.WeightedAverageAggregation
_types.FieldValue
A field value.
_types.aggregations.InferenceAggregation
_types.query_dsl.DateDistanceFeatureQuery
_types.query_dsl.DateRangeQuery
_types.TimeZone
string
_types.aggregations.InferenceConfigContainer
object
2 properties
_types.query_dsl.IntervalsPrefix
object
3 properties
1 required
_types.EmptyObject
object
For empty Class assignments
_global.reindex.RemoteSource
object
7 properties
1 required
_types.aggregations.ScriptedMetricAggregation
tasks._types.TaskInfos
_types.query_dsl.SpanNearQuery
_types.ExpandWildcard
string
_types.Slices
Slices configuration used to parallelize a process.
_types.query_dsl.RankFeatureFunctionLogarithm
_types.query_dsl.SpanFirstQuery
_types.TextEmbedding
object
2 properties
1 required
_types.aggregations.DateRangeAggregation
_types.aggregations.HoltMovingAverageAggregation
_types.aggregations.ExtendedStatsBucketAggregation
_types.aggregations.AggregationContainer
_types.aggregations.FormattableMetricAggregation
_types.aggregations.HoltWintersModelSettings
object
6 properties
_types.aggregations.HoltWintersMovingAverageAggregation
_types.aggregations.PercentilesBucketAggregation
_types.query_dsl.FieldValueFactorScoreFunction
object
4 properties
1 required
_types.query_dsl.IntervalsContainer
object
8 properties
_types.aggregations.StringStatsAggregation
_global.termvectors.FieldStatistics
object
3 properties
3 required
_types.MinimumShouldMatch
The minimum number of terms that should match as integer, percentage or range
_types.query_dsl.GeoPolygonQuery
_types.query_dsl.MatchAllQuery
_types.ScriptSort
object
5 properties
1 required
_types.Result
string
_global.mget.MultiGetError
object
3 properties
3 required
_global.search._types.SearchRequestBody
object
34 properties
_types.EpochTimeUnitMillis
_global.search._types.BoundaryScanner
string
_types.Sort
_types.query_dsl.DistanceFeatureQuery
_types.aggregations.VariableWidthHistogramAggregation
object
5 properties
_types.aggregations.RandomSamplerAggregation
_types.aggregations.AutoDateHistogramAggregation
_global.search._types.HighlightBase
object
21 properties
_types.aggregations.StatsBucketAggregation
_types.aggregations.FieldDateMath
A date range limit, represented either as a DateMath expression or a number expressed according to the target field's precision.
_types.Metadata
object
_types.aggregations.TDigest
object
2 properties
_types.DateTime
A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch…
_types.Routing
Only to be used in query and path parameters, as the array form is actually a csv
inference._types.EmbeddingContentType
string
_types.DistanceUnit
string
_types.aggregations.CompositeDateHistogramAggregation
tasks._types.NodeTasks
object
7 properties
1 required
_global.bulk.FailureStoreStatus
string
_types.Script
object
5 properties
_types.mapping.RuntimeField
object
9 properties
1 required
_types.query_dsl.SemanticQuery
_types.aggregations.IpRangeAggregation
_types.aggregations.ReverseNestedAggregation
_types.aggregations.GeoHashGridAggregation
_types.query_dsl.RangeQueryBase
_types.ShardFailure
object
6 properties
1 required
_types.TokenPruningConfig
object
3 properties
_types.NodeId
string
_types.query_dsl.NestedQuery
_types.query_dsl.PinnedDoc
object
2 properties
1 required
_types.query_dsl.QueryContainer
object
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
61 properties
_types.NestedSortValue
object
4 properties
1 required
_types.query_dsl.NumberRangeQuery
_global.update_by_query_rethrottle.UpdateByQueryRethrottleNode
_global.bulk.OperationContainer
object
An action line, which is the first line of each operation in a bulk request. It specifies the action to perform (index, create, update, or delete) and its meta…
4 properties
_types.aggregations.LinearMovingAverageAggregation
_types.query_dsl.SimpleQueryStringFlags
Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX
_types.RrfRank
_types.query_dsl.HasParentQuery
_types.query_dsl.TextQueryType
string
_types.query_dsl.GeoDistanceQuery
_types.query_dsl.RankFeatureFunctionSaturation
_types.query_dsl.BoolQuery
_types.aggregations.GlobalAggregation
_types.aggregations.ParentAggregation
_types.RetrieverContainer
object
9 properties
_types.Fuzziness
_types.aggregations.ScriptedHeuristic
object
1 property
1 required
_types.ChunkRescorer
object
2 properties
_types.aggregations.DateRangeExpression
object
3 properties
_types.query_dsl.ScriptScoreFunction
object
1 property
1 required
_types.SearchType
string
_types.query_dsl.LikeDocument
object
8 properties
_types.aggregations.BoxplotAggregation
_types.query_dsl.CombinedFieldsZeroTerms
string
_types.aggregations.Aggregation
object
_types.DiversifyRetriever
_types.query_dsl.FunctionScoreQuery
_types.RankBase
object
_types.SpecifiedDocument
object
2 properties
1 required
_types.aggregations.EwmaMovingAverageAggregation
_types.aggregations.CategorizeTextAggregation
A multi-bucket aggregation that groups semi-structured text into buckets. Each text field is re-analyzed using a custom analyzer. The resulting tokens are then…
_types.query_dsl.IntervalsRange
object
6 properties
_types.aggregations.BucketsPath
Buckets path can be expressed in different ways, and an aggregation may accept some or all of these forms depending on its type. Please refer to each aggregati…
_types.aggregations.FormatMetricAggregationBase
_types.TextSimilarityReranker
_types.query_dsl.DecayFunctionBaseGeoLocationDistance
object
1 property
_types.query_dsl.ExistsQuery
_global.get.GetResult
object
10 properties
3 required
_types.KnnRetriever
_types.query_dsl.HasChildQuery
_global.search._types.TrackHits
Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response do…
_types.query_dsl.MultiValueMode
string
_types.analysis.StopWords
Language value, such as arabic or thai. Defaults to english. Each language value corresponds to a predefined list of stop words in Lucene. See Stop words by la…
_types.aggregations.BucketCorrelationAggregation
A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.
_types.ScoreSort
object
1 property
_types.TaskFailure
object
4 properties
4 required
_types.Id
string
_types.aggregations.TermsAggregationExecutionHint
string
_types.mapping.ChunkRescorerChunkingSettings
object
6 properties
1 required
_types.aggregations.AggregationRange
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Stack 12
Other APIs Elastic Stack publishes across the network.
Elastic Cloud API
Elastic Stack (ELK Stack) Accounts API
Elastic Stack (ELK Stack) Actions API
Elastic Stack (ELK Stack) agent builder API
Elastic Stack (ELK Stack) Alerting API
Elastic Stack (ELK Stack) Alerting V2 API
Elastic Stack (ELK Stack) Analytics API
Elastic Stack (ELK Stack) APM agent configuration API
Elastic Stack (ELK Stack) APM agent keys API
Elastic Stack (ELK Stack) APM annotations API
Elastic Stack (ELK Stack) APM server schema API
Elastic Stack (ELK Stack) APM sourcemaps API
#Documents
Where this information came from
This is an independent, third-party profile of Elastic Stack (ELK Stack) Document API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.