Elastic Stack (ELK Stack) Watcher API
The watcher API from Elastic Stack (ELK Stack) — 13 operation(s) for watcher.
Elastic Stack (ELK Stack) Watcher 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 Watcher. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 24 operations across 13 paths, and defines 792 schemas. It is described by OpenAPI 3.2.0.
Requests are made against the base URL https://{elasticsearch_endpoint}.
24 operations
13 paths
792 schemas
1 DELETE5 GET10 POST8 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 24
Across 13 paths, the API surfaces 24 operations — 1 DELETE, 5 GET, 10 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.
Watcher 24
PUT
/_watcher/watch/{watch_id}/_ack
Acknowledge a watch
POST
/_watcher/watch/{watch_id}/_ack
Acknowledge a watch
PUT
/_watcher/watch/{watch_id}/_ack/{action_id}
Acknowledge a watch
POST
/_watcher/watch/{watch_id}/_ack/{action_id}
Acknowledge a watch
PUT
/_watcher/watch/{watch_id}/_activate
Activate a watch
POST
/_watcher/watch/{watch_id}/_activate
Activate a watch
PUT
/_watcher/watch/{watch_id}/_deactivate
Deactivate a watch
POST
/_watcher/watch/{watch_id}/_deactivate
Deactivate a watch
GET
/_watcher/watch/{id}
Get a watch
PUT
/_watcher/watch/{id}
Create or update a watch
POST
/_watcher/watch/{id}
Create or update a watch
DELETE
/_watcher/watch/{id}
Delete a watch
PUT
/_watcher/watch/{id}/_execute
Run a watch
POST
/_watcher/watch/{id}/_execute
Run a watch
PUT
/_watcher/watch/_execute
Run a watch
POST
/_watcher/watch/_execute
Run a watch
GET
/_watcher/settings
Get Watcher index settings
PUT
/_watcher/settings
Update Watcher index settings
GET
/_watcher/_query/watches
Query watches
POST
/_watcher/_query/watches
Query watches
POST
/_watcher/_start
Start the watch service
GET
/_watcher/stats
Get Watcher statistics
GET
/_watcher/stats/{metric}
Get Watcher statistics
POST
/_watcher/_stop
Stop the watch service
Schemas 792
The contract defines 792 schemas that model the data the API accepts and returns. The most detailed are _types.query_dsl.QueryContainer (61 properties), indices._types.IndexSettings (57 properties), _global.search._types.SearchRequestBody (34 properties), _global.search._types.HighlightBase (21 properties). Each schema is shown below with its type and property counts.
indices._types.IndexRoutingAllocation
object
4 properties
_types.GeoHashLocation
object
1 property
1 required
indices._types.SettingsSearch
object
2 properties
_types.query_dsl.PinnedQuery
_types.aggregations.IpRangeAggregationRange
object
3 properties
_types.analysis.PhoneticLanguage
string
_types.analysis.PatternReplaceCharFilter
_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
_types.analysis.ReverseTokenFilter
_types.Normalization
string
_types.ScriptSortType
string
_types.aggregations.SignificantTermsAggregation
_types.IBLambda
string
_types.analysis.DutchStemTokenFilter
_types.query_dsl.ConstantScoreQuery
_types.aggregations.BucketPathAggregation
indices._types.SettingsSimilarityBm25
object
4 properties
1 required
ml._types.RegressionInferenceOptions
object
2 properties
_types.analysis.KuromojiIterationMarkCharFilter
_types.SequenceNumber
number
_types.Distance
string
indices._types.SettingsSimilarityDfr
object
4 properties
4 required
_types.Host
string
_types.query_dsl.SimpleQueryStringFlag
string
_types.analysis.CommonGramsTokenFilter
_types.analysis.IcuAnalyzer
object
3 properties
3 required
indices._types.IndexSettingsUnassignedNodeLeft
object
1 property
watcher._types.DataAttachmentFormat
string
_types.KnnSearch
object
12 properties
1 required
_types.analysis.ScandinavianNormalizationTokenFilter
watcher._types.HttpInputRequestDefinition
object
13 properties
_types.Field
string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
watcher._types.ExecutionResultTransformType
string
_types.aggregations.CardinalityAggregation
_types.aggregations.RangeAggregation
_types.SortOptions
object
4 properties
_types.aggregations.Missing
_types.analysis.LimitTokenCountTokenFilter
_types.GeoDistanceType
string
_types.query_dsl.IntervalsFilter
object
9 properties
_types.aggregations.TopMetricsAggregation
_types.aggregations.MutualInformationHeuristic
object
2 properties
watcher._types.CronExpression
string
_types.query_dsl.DecayFunctionBase
object
1 property
watcher._types.ExecutionResult
object
6 properties
3 required
indices._types.IndexRoutingAllocationOptions
string
_types.query_dsl.FunctionScoreMode
string
_types.analysis.Analyzer
_types.ScriptTransform
object
4 properties
_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.analysis.RussianAnalyzer
object
4 properties
1 required
watcher._types.ExecutionThreadPool
object
2 properties
2 required
indices._types.IndexRoutingRebalance
object
1 property
1 required
_types.query_dsl.GeoExecution
string
_types.analysis.KeepWordsTokenFilter
_types.analysis.PhoneticNameType
string
_types.KnnEmbeddingInput
Knn embedding input. Either a string, an object or array of objects
_types.analysis.NoriPartOfSpeechTokenFilter
_types.analysis.PhoneticEncoder
string
_types.query_dsl.RangeQueryBasedouble
_types.aggregations.CustomCategorizeTextAnalyzer
object
3 properties
_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
_types.analysis.UaxEmailUrlTokenizer
_types.analysis.EdgeNGramTokenizer
indices._types.IndexRoutingAllocationInclude
object
2 properties
_types.mapping.RuntimeFieldType
string
indices._types.SegmentSortMissing
string
_types.analysis.SnowballLanguage
string
watcher._types.HttpInputResponseResult
object
3 properties
3 required
_types.TopRightBottomLeftGeoBounds
object
2 properties
2 required
indices._types.SettingsSimilarity
_global.search._types.Highlight
_types.analysis.WhitespaceAnalyzer
object
2 properties
1 required
watcher._types.SlackAction
object
2 properties
1 required
_types.analysis.KStemTokenFilter
_types.aggregations.FiltersAggregation
_types.analysis.MultiplexerTokenFilter
_types.aggregations.TestPopulation
object
3 properties
1 required
_types.aggregations.RateMode
string
indices._types.SearchIdle
object
1 property
watcher._types.HttpInputProxy
object
2 properties
2 required
_global.search._types.RescoreQuery
object
4 properties
1 required
_types.aggregations.IpPrefixAggregation
watcher._types.HttpInput
object
3 properties
_types.query_dsl.RangeQueryBasestring
_spec_utils.Stringifiedinteger
Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the sema…
_types.analysis.FingerprintAnalyzer
object
6 properties
1 required
_types.mapping.RuntimeFieldFetchFields
object
2 properties
1 required
_types.aggregations.BucketSortAggregation
_types.RescorerRetriever
watcher._types.IndexResultRequestSummary
object
4 properties
2 required
_types.query_dsl.DecayFunctionBasedoubledouble
object
1 property
_types.TopLeftBottomRightGeoBounds
object
2 properties
2 required
_types.aggregations.GeoBoundsAggregation
_types.aggregations.AggregateOrder
_types.analysis.TrimTokenFilter
_types.aggregations.TDigestExecutionHint
string
indices._types.IndexRoutingAllocationInitialRecovery
object
1 property
_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,…
_types.analysis.SimplePatternSplitTokenizer
_types.DFRBasicModel
string
_types.analysis.TokenFilterBase
object
1 property
_types.analysis.PhoneticRuleType
string
_types.VersionType
string
_types.aggregations.EwmaModelSettings
object
1 property
_types.aggregations.PValueHeuristic
object
2 properties
_global.search._types.HighlighterOrder
string
watcher.stats.WatchRecordQueuedStats
object
1 property
1 required
_types.analysis.ShingleTokenFilter
_types.query_dsl.IntervalsAllOf
object
4 properties
1 required
_types.analysis.IcuCollationAlternate
string
watcher._types.WatchStatus
object
6 properties
3 required
_types.analysis.EdgeNGramTokenFilter
_types.query_dsl.SimpleQueryStringQuery
_types.query_dsl.RuleQuery
_types.aggregations.MissingAggregation
_types.query_dsl.TermRangeQuery
_types.query_dsl.GeoDistanceFeatureQuery
watcher._types.Month
string
_types.query_dsl.RangeQuery
_types.aggregations.MatrixStatsAggregation
watcher._types.SlackDynamicAttachment
object
2 properties
2 required
watcher._types.AlwaysCondition
object
_types.aggregations.MovingAverageAggregationBase
inference._types.EmbeddingContentFormat
string
_types.GeoTilePrecision
number
_types.Username
string
_types.analysis.KeywordRepeatTokenFilter
_types.aggregations.MultiTermLookup
watcher._types.EmailAttachmentContainer
object
3 properties
indices._types.MappingLimitSettingsNestedObjects
object
1 property
watcher._types.SimulatedActions
object
3 properties
3 required
watcher._types.EmailPriority
string
_types.analysis.ChineseAnalyzer
object
3 properties
1 required
_types.analysis.EdgeNGramSide
string
watcher._types.SearchInputRequestDefinition
object
6 properties
_types.query_dsl.DecayFunction
_types.query_dsl.ParentIdQuery
_types.analysis.IcuFoldingTokenFilter
_types.analysis.GermanStemTokenFilter
watcher._types.ConditionContainer
object
5 properties
_types.query_dsl.WeightedTokensQuery
_types.query_dsl.FunctionScoreContainer
_types.aggregations.BucketScriptAggregation
_types.aggregations.CalendarInterval
string
_types.analysis.HunspellTokenFilter
_types.aggregations.FrequentItemSetsAggregation
object
5 properties
1 required
_types.aggregations.FrequentItemSetsField
object
3 properties
1 required
_types.analysis.CustomNormalizer
object
3 properties
1 required
_types.PinnedRetriever
_types.aggregations.CategorizeTextAnalyzer
indices._types.MappingLimitSettingsDepth
object
1 property
watcher._types.WebhookAction
_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
indices._types.MappingLimitSettingsSourceFields
object
1 property
1 required
_types.query_dsl.GeoGridQuery
watcher._types.HttpInputBasicAuthentication
object
2 properties
2 required
watcher._types.ScheduleTriggerEvent
object
2 properties
1 required
_types.analysis.KeywordAnalyzer
object
2 properties
1 required
_types.aggregations.CompositeAggregateKey
object
_types.query_dsl.SpanMultiTermQuery
watcher._types.IndexAction
object
6 properties
_types.QueryVector
array
_types.analysis.StemmerTokenFilter
_types.analysis.ConditionTokenFilter
indices._types.IndexRoutingRebalanceOptions
string
_types.GeoDistanceSort
object
6 properties
_types.analysis.RussianStemTokenFilter
_types.aggregations.HoltLinearModelSettings
object
2 properties
_types.query_dsl.IntervalsWildcard
object
3 properties
1 required
watcher._types.HttpInputAuthentication
object
1 property
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.analysis.KuromojiReadingFormTokenFilter
_types.query_dsl.GeoDecayFunction
watcher._types.QueryWatch
object
5 properties
1 required
_types.aggregations.CumulativeCardinalityAggregation
_types.HttpHeaders
object
_types.query_dsl.MoreLikeThisQuery
_types.analysis.PersianStemTokenFilter
indices._types.SettingsSimilarityIb
object
4 properties
4 required
indices._types.MappingLimitSettingsNestedFields
object
1 property
_types.analysis.IcuCollationTokenFilter
_types.analysis.ArabicStemTokenFilter
watcher.stats.WatcherState
string
indices._types.IndexingPressureMemory
object
1 property
_types.WktGeoBounds
object
1 property
1 required
watcher._types.ScheduleTimeOfDay
A time of day, expressed either as hh:mm, noon, midnight, or an hour/minutes structure.
_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.analysis.CzechAnalyzer
object
4 properties
1 required
indices._types.SlowlogSettings
object
4 properties
_types.query_dsl.FieldValueFactorModifier
string
_types.aggregations.NormalizeMethod
string
_types.aggregations.DiversifiedSamplerAggregation
_types.analysis.SpanishAnalyzer
object
4 properties
1 required
_types.aggregations.ExtendedBoundsdouble
object
2 properties
_types.query_dsl.MatchPhrasePrefixQuery
_types.analysis.LowercaseTokenFilterLanguages
string
_global.search._types.HighlighterFragmenter
string
_types.aggregations.TopMetricsValue
object
1 property
1 required
watcher._types.ExecutionState
object
3 properties
2 required
_types.query_dsl.FuzzyQuery
_types.analysis.PredicateTokenFilter
indices._types.RetentionLease
object
1 property
1 required
watcher._types.TimeOfMonth
object
2 properties
2 required
_types.analysis.KuromojiTokenizationMode
string
_types.aggregations.CardinalityExecutionMode
string
_types.query_dsl.TextExpansionQuery
_global.search._types.PointInTimeReference
object
2 properties
1 required
_types.analysis.PorterStemTokenFilter
_types.query_dsl.SpanTermQuery
_types.SortResults
array
_types.analysis.BasqueAnalyzer
object
4 properties
1 required
_types.query_dsl.ScriptQuery
_types.analysis.ThaiTokenizer
indices._types.IndexRouting
object
2 properties
_types.analysis.PhoneticTokenFilter
_types.aggregations.PipelineAggregationBase
watcher._types.HttpInputRequestResult
_types.analysis.LowercaseTokenizer
_types.analysis.BrazilianStemTokenFilter
_types.ByteSize
_types.query_dsl.UntypedDecayFunction
watcher._types.TimeOfWeek
object
2 properties
2 required
_types.analysis.WhitespaceTokenizer
_types.analysis.ItalianAnalyzer
object
4 properties
1 required
_types.analysis.NoriTokenizer
indices._types.SoftDeletes
object
2 properties
watcher._types.SlackAttachmentField
object
3 properties
3 required
_types.query_dsl.RegexpQuery
watcher._types.PagerDutyResult
object
4 properties
1 required
_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
indices._types.MappingLimitSettingsFieldNameLength
object
1 property
_types.aggregations.ChiSquareHeuristic
object
2 properties
2 required
_types.aggregations.BucketCorrelationFunctionCountCorrelation
object
1 property
1 required
_types.aggregations.ExtendedBoundsFieldDateMath
object
2 properties
_types.analysis.WordDelimiterTokenFilter
_types.Embedding
object
3 properties
1 required
_types.analysis.PatternCaptureTokenFilter
_types.query_dsl.BoostingQuery
indices._types.IndexSettings
object
57 properties
watcher._types.ExecutionResultAction
_types.aggregations.TimeSeriesAggregation
_types.aggregations.TermsAggregation
_types.aggregations.MaxAggregation
_types.analysis.KuromojiAnalyzer
object
3 properties
1 required
_types.analysis.UniqueTokenFilter
_types.query_dsl.IntervalsAnyOf
object
2 properties
1 required
_types.analysis.IrishAnalyzer
object
4 properties
1 required
_types.ScriptSource
_types.analysis.IcuNormalizationCharFilter
_types.query_dsl.GeoShapeQuery
watcher._types.ExecutionResultForeachAction
object
The result of a single action execution.
8 properties
_types.analysis.DutchAnalyzer
object
4 properties
1 required
_types.query_dsl.FunctionBoostMode
string
_types.analysis.SerbianNormalizationTokenFilter
_types.Fields
_types.query_dsl.RangeQueryBaseDateMath
_types.aggregations.SamplerAggregationExecutionHint
string
_types.query_dsl.TypeQuery
_types.aggregations.CartesianBoundsAggregation
_types.analysis.NGramTokenizer
_types.Password
string
_types.query_dsl.IntervalsRegexp
object
3 properties
1 required
_types.aggregations.CompositeAggregationSource
object
4 properties
_types.query_dsl.SpanFieldMaskingQuery
_types.analysis.FingerprintTokenFilter
_types.query_dsl.CommonTermsQuery
_types.VersionNumber
number
_types.analysis.IcuCollationCaseFirst
string
_types.aggregations.StatsAggregation
_types.query_dsl.UntypedRangeQuery
indices._types.SlowlogTresholdLevels
object
4 properties
indices._types.StorageType
watcher._types.Email
object
11 properties
2 required
_types.DateMath
string
_types.VersionString
string
_types.mapping.CompositeSubField
object
1 property
1 required
_types.aggregations.DerivativeAggregation
_types.analysis.ClassicTokenizer
watcher.execute_watch.WatchRecord
object
14 properties
5 required
_types.analysis.UppercaseTokenFilter
_types.analysis.BengaliAnalyzer
object
4 properties
1 required
_types.analysis.IcuTransformTokenFilter
_types.query_dsl.MatchQuery
watcher._types.TimeOfYear
object
3 properties
3 required
_types.aggregations.TermsExclude
_types.aggregations.CompositeTermsAggregation
_types.aggregations.BucketSelectorAggregation
_types.query_dsl.SpanContainingQuery
_types.query_dsl.CombinedFieldsQuery
_types.aggregations.ChildrenAggregation
indices._types.SettingsSimilarityBoolean
object
1 property
1 required
_types.query_dsl.RangeRelation
string
_types.Uuid
string
indices._types.Merge
object
1 property
watcher._types.ExecutionPhase
string
_types.ScriptField
object
2 properties
1 required
_types.query_dsl.MatchBoolPrefixQuery
watcher._types.ThrottleState
object
2 properties
2 required
_types.query_dsl.GeoBoundingBoxQuery
_types.analysis.GermanAnalyzer
object
4 properties
1 required
_types.analysis.TruncateTokenFilter
_types.GeoHexCell
string
A map hex cell (H3) reference
_types.analysis.ClassicTokenFilter
_types.aggregations.SerialDifferencingAggregation
_types.aggregations.GeoDistanceAggregation
_types.analysis.BengaliNormalizationTokenFilter
_types.analysis.TokenChar
string
_types.aggregations.ExtendedStatsAggregation
_types.aggregations.RareTermsAggregation
_types.Name
string
_types.analysis.CjkBigramIgnoredScript
string
_types.analysis.NorwegianAnalyzer
object
4 properties
1 required
indices._types.SegmentSortMode
string
_types.aggregations.MovingAverageAggregation
_types.aggregations.AverageBucketAggregation
_types.query_dsl.QueryBase
object
2 properties
_types.aggregations.MinimumInterval
string
_types.NodeStatistics
object
Contains statistics about the number of nodes selected by the request.
4 properties
3 required
_types.query_dsl.IntervalsFuzzy
object
6 properties
1 required
_types.aggregations.AdjacencyMatrixAggregation
_types.aggregations.GoogleNormalizedDistanceHeuristic
object
1 property
indices._types.SettingsSimilarityLmj
object
2 properties
1 required
watcher._types.PagerDutyContextType
string
_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.uint
number
_types.analysis.StopWordLanguage
string
_types.aggregations.PercentageScoreHeuristic
object
_types.query_dsl.PrefixQuery
_types.IndexName
string
watcher._types.LoggingResult
object
1 property
1 required
_types.UnitSeconds
number
Time unit for seconds
_global.search._types.InnerHits
object
17 properties
_types.analysis.FinnishAnalyzer
object
4 properties
1 required
_types.query_dsl.SpanWithinQuery
_types.aggregations.MedianAbsoluteDeviationAggregation
_types.analysis.IcuTransformDirection
string
_types.analysis.ElisionTokenFilter
watcher._types.IndexResult
object
The result of an index action. It is a container that holds either the response of an executed index operation, or the request that would have run when the act…
2 properties
_types.query_dsl.SpanOrQuery
_types.analysis.SoraniAnalyzer
object
4 properties
1 required
_types.aggregations.MetricAggregationBase
object
3 properties
_types.mapping.OnScriptError
string
watcher._types.ExecutionResultCondition
object
5 properties
3 required
_global.search._types.HighlighterTagsSchema
string
_types.aggregations.BucketCorrelationFunction
object
1 property
1 required
indices._types.SettingsSimilarityScripted
object
3 properties
2 required
_global.search._types.Rescore
_global.search._types.HighlighterEncoder
string
indices._types.MappingLimitSettingsTotalFields
object
2 properties
_types.analysis.ArabicNormalizationTokenFilter
_types.ExpandWildcards
_types.query_dsl.RankFeatureFunctionLinear
_types.SortMode
string
_types.SearchTransform
object
2 properties
1 required
watcher.stats.WatcherMetric
string
_global.search._types.SourceConfig
Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
watcher._types.TriggerEventResult
object
3 properties
3 required
_types.analysis.FrenchAnalyzer
object
4 properties
1 required
_global.search._types.HighlightField
watcher._types.DataEmailAttachment
object
1 property
_types.analysis.HungarianAnalyzer
object
4 properties
1 required
indices._types.IndexCheckOnStartup
string
_types.query_dsl.RandomScoreFunction
object
2 properties
watcher._types.ResponseContentType
string
_types.aggregations.NormalizeAggregation
_types.query_dsl.TermsSetQuery
_types.ScoreNormalizer
string
_types.query_dsl.DistanceFeatureQueryBaseDateMathDuration
_types.query_dsl.ShapeQuery
_types.aggregations.TopHitsAggregation
_types.analysis.HtmlStripCharFilter
_types.KnnQuery
_types.aggregations.HdrMethod
object
1 property
_types.aggregations.TTestAggregation
_types.query_dsl.IdsQuery
_types.LatLonGeoLocation
object
2 properties
2 required
_types.aggregations.MinBucketAggregation
_types.query_dsl.DateDecayFunction
_types.GeoHash
string
indices._types.IndexVersioning
object
2 properties
_types.mapping.RuntimeFields
object
_global.search._types.SourceFilter
object
3 properties
_types.aggregations.RateAggregation
_types.aggregations.CompositeAggregationBase
object
6 properties
_types.aggregations.TermsAggregationCollectMode
string
_types.IBDistribution
string
_types.analysis.IcuCollationDecomposition
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.query_dsl.TermsQuery
_types.aggregations.NestedAggregation
_types.RankContainer
object
1 property
watcher._types.HourlySchedule
object
1 property
1 required
_types.query_dsl.PercolateQuery
_types.aggregations.HoltWintersType
string
_types.query_dsl.MultiMatchQuery
_types.analysis.HindiNormalizationTokenFilter
_types.IndicesOptions
object
Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded to actual indices (all, closed or open indice…
4 properties
_types.analysis.CjkWidthTokenFilter
_types.analysis.ArmenianAnalyzer
object
4 properties
1 required
_types.aggregations.MovingFunctionAggregation
_types.aggregations.TermsInclude
_global.search._types.LearningToRank
object
2 properties
1 required
_types.analysis.WordDelimiterGraphTokenFilter
_types.aggregations.GeoTileGridAggregation
_types.Refresh
string
_types.CoordsGeoBounds
object
4 properties
4 required
_types.analysis.SerbianAnalyzer
object
4 properties
1 required
_types.DiversifyRetrieverTypes
string
_types.analysis.CharFilterBase
object
1 property
_types.QueryVectorBuilder
object
3 properties
_types.analysis.RemoveDuplicatesTokenFilter
_types.analysis.StandardAnalyzer
object
4 properties
1 required
_types.aggregations.PercentileRanksAggregation
watcher._types.ExecutionResultSearchInput
object
1 property
1 required
_types.analysis.KeywordTokenizer
_types.analysis.LengthTokenFilter
indices._types.SettingsSimilarityDfi
object
2 properties
2 required
_types.analysis.TokenizerBase
object
1 property
_types.query_dsl.MatchPhraseQuery
_types.InferenceStringGroup
_types.analysis.IndonesianAnalyzer
object
4 properties
1 required
_types.SortCombinations
_types.query_dsl.RangeQueryBaselong
indices._types.Translog
object
4 properties
_types.aggregations.SumBucketAggregation
watcher._types.PagerDutyContext
object
3 properties
1 required
watcher.stats.WatchRecordStats
indices._types.Queries
object
1 property
_types.analysis.ArabicAnalyzer
object
4 properties
1 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.analysis.RomanianAnalyzer
object
4 properties
1 required
watcher._types.Actions
object
_types.analysis.SynonymTokenFilter
_types.aggregations.ValueCountAggregation
_types.aggregations.GapPolicy
string
_types.analysis.PathHierarchyTokenizer
_types.analysis.GreekAnalyzer
object
3 properties
1 required
_types.analysis.IcuNormalizationMode
string
_types.aggregations.ValueType
string
_types.query_dsl.DisMaxQuery
_types.query_dsl.GeoValidationMethod
string
indices._types.TranslogDurability
string
_global.search._types.ScriptRescore
object
1 property
1 required
_types.aggregations.GeoLineSort
object
1 property
1 required
_types.aggregations.SimpleMovingAverageAggregation
watcher._types.SlackAttachment
object
15 properties
2 required
_types.InferenceString
object
3 properties
2 required
_types.DateFormat
string
_types.UnitMillis
number
Time unit for milliseconds
_types.SortOrder
string
indices._types.SettingsAnalyze
object
1 property
_types.analysis.JaStopTokenFilter
_types.ScriptLanguage
_types.analysis.CatalanAnalyzer
object
4 properties
1 required
watcher._types.ExecutionStatus
string
_global.search._types.Suggester
object
1 property
watcher._types.HttpEmailAttachment
object
3 properties
indices._types.IndexingSlowlogSettings
object
4 properties
watcher._types.WebhookResult
object
2 properties
1 required
ml._types.ClassificationInferenceOptions
object
5 properties
_types.RuleRetriever
_types.DurationValueUnitMillis
_types.query_dsl.TermQuery
watcher._types.ExecutionResultStatus
string
_types.analysis.DictionaryDecompounderTokenFilter
_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.EpochTimeUnitSeconds
_types.analysis.SoraniNormalizationTokenFilter
_types.analysis.KuromojiPartOfSpeechTokenFilter
_types.analysis.GalicianAnalyzer
object
4 properties
1 required
indices._types.IndexSettingsAnalysis
object
5 properties
_types.DFRAfterEffect
string
_types.analysis.SnowballAnalyzer
object
4 properties
2 required
watcher._types.ActionStatus
object
4 properties
1 required
_spec_utils.Stringifiedboolean
Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the sema…
_types.analysis.PatternReplaceTokenFilter
indices._types.IndexSettingsTimeSeries
object
3 properties
watcher._types.PagerDutyEventType
string
watcher._types.ChainInput
object
1 property
1 required
indices._types.SettingsQueryString
object
1 property
1 required
_types.RRFRetrieverEntry
Either a direct RetrieverContainer (backward compatible) or an RRFRetrieverComponent with weight.
_types.aggregations.ChangePointAggregation
_types.aggregations.TTestType
string
_types.aggregations.MinAggregation
_types.RetrieverBase
object
3 properties
_types.aggregations.MultiTermsAggregation
_types.analysis.StopTokenFilter
indices._types.SlowlogTresholds
object
2 properties
watcher._types.ExecutionResultHttpInput
object
2 properties
1 required
_types.query_dsl.DecayFunctionBaseDateMathDuration
object
1 property
watcher._types.SlackMessage
object
6 properties
4 required
indices._types.IndexSettingsLifecycle
object
7 properties
_types.query_dsl.MatchNoneQuery
_types.aggregations.MovingPercentilesAggregation
_types.aggregations.CompositeGeoTileGridAggregation
_types.query_dsl.IntervalsQuery
watcher._types.ActivationState
object
2 properties
2 required
_types.analysis.IcuTokenizer
_types.analysis.BulgarianAnalyzer
object
4 properties
1 required
_types.StandardRetriever
_types.query_dsl.DistanceFeatureQueryBase
_types.query_dsl.RankFeatureQuery
watcher._types.ActionExecutionMode
string
watcher._types.ActionStatusOptions
string
_types.Names
_types.analysis.IcuNormalizationTokenFilter
_types.analysis.AsciiFoldingTokenFilter
_types.PipelineName
string
watcher._types.IndexResultSummary
object
A single item of an index action result. Successful items and failed items expose different fields; only id and index are present in both. Failed items appear…
7 properties
2 required
_types.query_dsl.ScriptScoreQuery
_types.analysis.CharGroupTokenizer
_types.aggregations.GeoLineAggregation
object
5 properties
1 required
_types.analysis.CzechStemTokenFilter
_types.analysis.NoriAnalyzer
object
5 properties
1 required
_types.query_dsl.NumericDecayFunction
_types.aggregations.AverageAggregation
_types.query_dsl.SparseVectorQuery
watcher._types.DailySchedule
object
1 property
1 required
_types.OpType
string
_types.aggregations.HistogramAggregation
_types.query_dsl.Operator
string
_types.analysis.LowercaseNormalizer
object
1 property
1 required
_types.query_dsl.LongNumberRangeQuery
_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.
_types.SlicedScroll
object
3 properties
2 required
watcher._types.NeverCondition
object
_global.search._types.HighlighterType
watcher._types.HourAndMinute
object
2 properties
2 required
_types.analysis.PortugueseAnalyzer
object
4 properties
1 required
_types.aggregations.GeohexGridAggregation
_types.aggregations.DateHistogramAggregation
_types.analysis.TurkishAnalyzer
object
4 properties
1 required
_types.analysis.HyphenationDecompounderTokenFilter
_types.AcknowledgedResponseBase
object
1 property
1 required
watcher.stats.WatcherNodeStats
object
6 properties
4 required
watcher._types.EmailResult
object
3 properties
1 required
_types.analysis.DelimitedPayloadTokenFilter
_types.GeoTile
string
A map tile reference, represented as {zoom}/{x}/{y}
_types.analysis.SnowballTokenFilter
_types.query_dsl.ZeroTermsQuery
string
_types.aggregations.PercentilesAggregation
_types.analysis.NGramTokenFilter
_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator
object
3 properties
2 required
_types.analysis.TokenFilterDefinition
watcher._types.EmailBody
object
2 properties
_types.analysis.StemmerOverrideTokenFilter
_types.query_dsl.RankFeatureFunctionSigmoid
watcher._types.LoggingAction
object
3 properties
1 required
_types.aggregations.BucketAggregationBase
Base type for bucket aggregations. These aggregations also accept sub-aggregations.
indices._types.SourceMode
string
_types.aggregations.WeightedAverageAggregation
_types.FieldValue
A field value.
_types.analysis.DelimitedPayloadEncoding
string
_types.aggregations.InferenceAggregation
watcher._types.ActivationStatus
object
3 properties
3 required
_types.query_dsl.DateDistanceFeatureQuery
_types.query_dsl.DateRangeQuery
indices._types.MergeScheduler
object
2 properties
_types.analysis.FlattenGraphTokenFilter
_types.TimeZone
string
_types.aggregations.InferenceConfigContainer
object
2 properties
watcher._types.ExecutionResultTransform
object
6 properties
2 required
_types.query_dsl.IntervalsPrefix
object
3 properties
1 required
_types.analysis.LatvianAnalyzer
object
4 properties
1 required
_types.EmptyObject
object
For empty Class assignments
_types.aggregations.ScriptedMetricAggregation
_types.query_dsl.SpanNearQuery
_types.ExpandWildcard
string
_types.analysis.CjkBigramTokenFilter
_types.query_dsl.RankFeatureFunctionLogarithm
_types.analysis.IcuNormalizationType
string
_types.analysis.CustomAnalyzer
object
6 properties
2 required
_types.analysis.IcuCollationStrength
string
_types.analysis.TokenizerDefinition
watcher._types.ExecutionResultConditionResolved
object
1 property
indices._types.MappingLimitSettings
object
Mapping Limit Settings
9 properties
watcher._types.ConnectionScheme
string
_types.query_dsl.SpanFirstQuery
_types.analysis.ApostropheTokenFilter
_types.analysis.PatternTokenizer
_types.TextEmbedding
object
2 properties
1 required
_types.analysis.NoriDecompoundMode
string
_types.aggregations.DateRangeAggregation
watcher._types.PagerDutyEvent
object
9 properties
3 required
_types.analysis.LithuanianAnalyzer
object
4 properties
1 required
indices._types.TranslogRetention
object
2 properties
watcher._types.PagerDutyEventProxy
object
2 properties
_types.aggregations.HoltMovingAverageAggregation
_types.aggregations.ExtendedStatsBucketAggregation
indices._types.Storage
object
3 properties
1 required
watcher._types.HttpInputMethod
string
_types.aggregations.AggregationContainer
_types.aggregations.FormattableMetricAggregation
_types.analysis.LetterTokenizer
_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
watcher._types.SearchTemplateRequestBody
object
6 properties
_types.analysis.FrenchStemTokenFilter
_types.aggregations.StringStatsAggregation
indices._types.CacheQueries
object
1 property
1 required
_types.analysis.SwedishAnalyzer
object
4 properties
1 required
watcher._types.Action
object
14 properties
_types.MinimumShouldMatch
The minimum number of terms that should match as integer, percentage or range
_types.query_dsl.GeoPolygonQuery
_types.analysis.PersianNormalizationTokenFilter
watcher._types.SlackResult
object
2 properties
1 required
_types.analysis.GermanNormalizationTokenFilter
watcher._types.PagerDutyAction
_types.query_dsl.MatchAllQuery
_types.ScriptSort
object
5 properties
1 required
_types.Result
string
_types.analysis.CharFilterDefinition
_global.search._types.SearchRequestBody
object
34 properties
_types.analysis.PersianAnalyzer
object
3 properties
1 required
_types.EpochTimeUnitMillis
_global.search._types.BoundaryScanner
string
watcher._types.ConditionType
string
_types.analysis.Normalizer
indices._types.IndexSettingBlocks
object
5 properties
_types.Sort
_types.query_dsl.DistanceFeatureQuery
indices._types.SegmentSortOrder
string
_types.aggregations.VariableWidthHistogramAggregation
object
5 properties
_types.aggregations.RandomSamplerAggregation
_types.aggregations.AutoDateHistogramAggregation
watcher._types.ArrayCompareCondition
object
1 property
1 required
_global.search._types.HighlightBase
object
21 properties
watcher._types.TriggerEventContainer
object
1 property
_spec_utils.NullValue
stringnull
A null value that is to be interpreted as an actual value, unless other uses of null that are equivalent to a missing value. It is used for exemple in settings…
_types.analysis.BrazilianAnalyzer
object
3 properties
1 required
watcher._types.ReportingEmailAttachment
object
5 properties
1 required
_types.analysis.KuromojiStemmerTokenFilter
_types.analysis.LowercaseTokenFilter
_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.analysis.DanishAnalyzer
object
3 properties
1 required
_types.analysis.CharFilter
_types.analysis.StandardTokenizer
_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.aggregations.TDigest
object
2 properties
_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.analysis.SimpleAnalyzer
object
2 properties
1 required
indices._types.IndexingSlowlogTresholds
object
1 property
_types.aggregations.CompositeDateHistogramAggregation
_types.analysis.PatternAnalyzer
object
7 properties
1 required
_types.Script
object
5 properties
_types.mapping.RuntimeField
object
9 properties
1 required
_types.analysis.StopAnalyzer
object
4 properties
1 required
_types.analysis.CjkAnalyzer
object
3 properties
1 required
_types.query_dsl.SemanticQuery
_types.aggregations.IpRangeAggregation
_types.analysis.SynonymFormat
string
_types.aggregations.ReverseNestedAggregation
watcher._types.ExecutionResultInput
object
7 properties
2 required
indices._types.IndexSettingsLifecycleStep
object
1 property
_types.aggregations.GeoHashGridAggregation
_types.analysis.KeywordMarkerTokenFilter
_types.query_dsl.RangeQueryBase
watcher._types.Day
string
_types.DFIIndependenceMeasure
string
_types.TokenPruningConfig
object
3 properties
indices._types.SettingsSimilarityLmd
object
2 properties
1 required
_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
_types.analysis.ThaiAnalyzer
object
3 properties
1 required
indices._types.MappingLimitSettingsDimensionFields
object
1 property
_types.analysis.TokenFilter
watcher._types.SearchInput
object
3 properties
1 required
_types.analysis.KeepTypesTokenFilter
_types.aggregations.LinearMovingAverageAggregation
watcher._types.ActionType
string
indices._types.IndexSettingsUnassigned
object
1 property
_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.analysis.KeepTypesMode
string
_types.query_dsl.TextQueryType
string
_types.query_dsl.GeoDistanceQuery
_types.query_dsl.RankFeatureFunctionSaturation
_types.query_dsl.BoolQuery
_types.aggregations.GlobalAggregation
indices._types.IndexRoutingAllocationDisk
object
1 property
indices._types.IndexSegmentSort
object
4 properties
_types.aggregations.ParentAggregation
_types.analysis.Tokenizer
_types.RetrieverContainer
object
9 properties
_types.Fuzziness
_types.aggregations.ScriptedHeuristic
object
1 property
1 required
_types.analysis.KuromojiTokenizer
_types.ChunkRescorer
object
2 properties
watcher._types.Watch
object
9 properties
3 required
_types.aggregations.DateRangeExpression
object
3 properties
_types.query_dsl.ScriptScoreFunction
object
1 property
1 required
_types.SearchType
string
indices._types.IndexingPressure
object
1 property
1 required
_types.query_dsl.LikeDocument
object
8 properties
_types.aggregations.BoxplotAggregation
_spec_utils.StringifiedEpochTimeUnitMillis
Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the sema…
_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.TransformContainer
object
3 properties
watcher._types.TriggerContainer
object
1 property
watcher._types.AcknowledgementOptions
string
_types.analysis.WordDelimiterTokenFilterBase
_types.TextSimilarityReranker
_types.query_dsl.DecayFunctionBaseGeoLocationDistance
object
1 property
_types.query_dsl.ExistsQuery
watcher._types.AcknowledgeState
object
2 properties
2 required
_types.analysis.IndicNormalizationTokenFilter
_types.KnnRetriever
_types.analysis.MinHashTokenFilter
_types.query_dsl.HasChildQuery
_types.analysis.ScandinavianFoldingTokenFilter
indices._types.SettingsHighlight
object
1 property
_types.analysis.MappingCharFilter
_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.SynonymTokenFilterBase
_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.analysis.SynonymGraphTokenFilter
_types.analysis.DecimalDigitTokenFilter
_types.analysis.EstonianAnalyzer
object
3 properties
1 required
_types.analysis.HindiAnalyzer
object
4 properties
1 required
watcher._types.EmailAction
_types.analysis.SimplePatternTokenizer
_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.analysis.EnglishAnalyzer
object
4 properties
1 required
_types.analysis.CompoundWordTokenFilterBase
watcher._types.ScheduleContainer
object
8 properties
_types.Id
string
_types.aggregations.TermsAggregationExecutionHint
string
watcher._types.InputContainer
object
5 properties
_types.mapping.ChunkRescorerChunkingSettings
object
6 properties
1 required
_types.aggregations.AggregationRange
object
3 properties
watcher._types.ScriptCondition
object
4 properties
watcher._types.InputType
string
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
#Watcher
Where this information came from
This is an independent, third-party profile of Elastic Stack (ELK Stack) Watcher 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.