Elastic Stack (ELK Stack) Snapshot API
The snapshot API from Elastic Stack (ELK Stack) — 12 operation(s) for snapshot.
Elastic Stack (ELK Stack) Snapshot API is one of 132 APIs that Elastic Stack (ELK Stack) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Snapshot. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 18 operations across 12 paths, and defines 722 schemas. It is described by OpenAPI 3.2.0.
Requests are made against the base URL https://{elasticsearch_endpoint}.
18 operations
12 paths
722 schemas
2 DELETE6 GET7 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 18
Across 12 paths, the API surfaces 18 operations — 2 DELETE, 6 GET, 7 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
snapshot 18
POST
/_snapshot/{repository}/_cleanup
Clean up the snapshot repository
PUT
/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}
Clone a snapshot
GET
/_snapshot/{repository}/{snapshot}
Get snapshot information
PUT
/_snapshot/{repository}/{snapshot}
Create a snapshot
POST
/_snapshot/{repository}/{snapshot}
Create a snapshot
DELETE
/_snapshot/{repository}/{snapshot}
Delete snapshots
GET
/_snapshot/{repository}
Get snapshot repository information
PUT
/_snapshot/{repository}
Create or update a snapshot repository
POST
/_snapshot/{repository}
Create or update a snapshot repository
DELETE
/_snapshot/{repository}
Delete snapshot repositories
GET
/_snapshot
Get snapshot repository information
POST
/_snapshot/{repository}/_analyze
Analyze a snapshot repository
POST
/_snapshot/{repository}/_verify_integrity
Verify the repository integrity
POST
/_snapshot/{repository}/{snapshot}/_restore
Restore a snapshot
GET
/_snapshot/_status
Get the snapshot status
GET
/_snapshot/{repository}/_status
Get the snapshot status
GET
/_snapshot/{repository}/{snapshot}/_status
Get the snapshot status
POST
/_snapshot/{repository}/_verify
Verify a snapshot repository
Schemas 722
The contract defines 722 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), snapshot._types.SnapshotInfo (21 properties). Each schema is shown below with its type and property counts.
_types.query_dsl.SpanContainingQuery
_types.query_dsl.TypeQuery
_types.analysis.MinHashTokenFilter
snapshot._types.SourceOnlyRepositorySettingsForS3
object
16 properties
2 required
_types.aggregations.TopHitsAggregation
_types.query_dsl.CombinedFieldsZeroTerms
string
_types.aggregations.BucketSelectorAggregation
_types.analysis.HunspellTokenFilter
_types.aggregations.TermsPartition
object
2 properties
2 required
_types.query_dsl.GeoBoundingBoxQuery
_types.analysis.DanishAnalyzer
object
3 properties
1 required
_types.SortResults
array
indices._types.SoftDeletes
object
2 properties
_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator
object
3 properties
2 required
indices._types.SegmentSortMode
string
_types.analysis.KuromojiAnalyzer
object
3 properties
1 required
_types.aggregations.ChildrenAggregation
_types.EpochTimeUnitMillis
_types.aggregations.MatrixAggregation
snapshot._types.Status
object
8 properties
8 required
_types.query_dsl.DisMaxQuery
_types.aggregations.SamplerAggregationExecutionHint
string
_types.aggregations.MovingPercentilesAggregation
_types.aggregations.HoltWintersModelSettings
object
6 properties
_types.aggregations.HistogramAggregation
snapshot._types.ShardsStatsSummaryItem
object
2 properties
2 required
snapshot._types.SharedFileSystemRepository
_types.GeoTilePrecision
number
_types.analysis.CompoundWordTokenFilterBase
_types.aggregations.DateRangeAggregation
indices._types.MappingLimitSettingsFieldNameLength
object
1 property
indices._types.SettingsSimilarityDfr
object
4 properties
4 required
indices._types.TranslogRetention
object
2 properties
_types.aggregations.StringStatsAggregation
snapshot.repository_analyze.DetailsInfo
object
8 properties
6 required
_types.analysis.BulgarianAnalyzer
object
4 properties
1 required
_types.aggregations.TTestType
string
_types.TextSimilarityReranker
_types.aggregations.ParentAggregation
_types.aggregations.MaxBucketAggregation
_global.search._types.FieldCollapse
object
4 properties
1 required
_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.query_dsl.RangeQueryBase
_types.query_dsl.NumericDecayFunction
_types.analysis.StemmerOverrideTokenFilter
_types.aggregations.FormattableMetricAggregation
indices._types.RetentionLease
object
1 property
1 required
_types.analysis.TokenizerDefinition
_types.query_dsl.UntypedRangeQuery
_types.IndexName
string
_types.aggregations.GeoLineSort
object
1 property
1 required
_types.analysis.KuromojiPartOfSpeechTokenFilter
_types.Uuid
string
_types.aggregations.MultiTermLookup
_types.query_dsl.DecayFunctionBaseGeoLocationDistance
object
1 property
_types.aggregations.CompositeAggregation
_types.analysis.HyphenationDecompounderTokenFilter
_types.query_dsl.SemanticQuery
_types.aggregations.InferenceAggregation
_types.analysis.ArabicAnalyzer
object
4 properties
1 required
_types.aggregations.HoltWintersMovingAverageAggregation
_types.query_dsl.TextQueryType
string
_types.analysis.KuromojiIterationMarkCharFilter
_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.SimplePatternSplitTokenizer
_types.aggregations.ScriptedMetricAggregation
_types.analysis.ScandinavianNormalizationTokenFilter
_types.aggregations.StatsBucketAggregation
_types.query_dsl.RangeQueryBaselong
_types.analysis.DictionaryDecompounderTokenFilter
_types.analysis.UppercaseTokenFilter
_types.aggregations.BucketPathAggregation
_types.analysis.DelimitedPayloadEncoding
string
_types.aggregations.AggregationRange
object
3 properties
_types.DateFormat
string
_types.analysis.CustomNormalizer
object
3 properties
1 required
_types.DiversifyRetriever
_types.query_dsl.TextExpansionQuery
_types.analysis.ClassicTokenFilter
_types.analysis.SimplePatternTokenizer
_types.analysis.SimpleAnalyzer
object
2 properties
1 required
snapshot._types.SnapshotState
string
_types.analysis.MultiplexerTokenFilter
_types.aggregations.ExtendedStatsBucketAggregation
_types.analysis.CjkAnalyzer
object
3 properties
1 required
_types.analysis.TrimTokenFilter
_types.analysis.PersianNormalizationTokenFilter
_types.analysis.IndicNormalizationTokenFilter
_types.GeoHash
string
_types.query_dsl.WildcardQuery
_global.search._types.HighlighterOrder
string
_types.query_dsl.FuzzyQuery
_types.Id
string
_types.InnerRetriever
object
3 properties
3 required
_types.ShardFailure
object
6 properties
1 required
_types.query_dsl.SparseVectorQuery
_types.analysis.PhoneticNameType
string
_types.SlicedScroll
object
3 properties
2 required
_types.aggregations.SignificantTextAggregation
_types.aggregations.SignificantTermsAggregation
indices._types.IndexSettingsUnassigned
object
1 property
snapshot._types.Repository
indices._types.SettingsSimilarityBoolean
object
1 property
1 required
_types.query_dsl.MultiValueMode
string
_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance
snapshot._types.SnapshotShardFailure
object
6 properties
5 required
_types.Sort
_types.query_dsl.TermsSetQuery
_types.aggregations.GoogleNormalizedDistanceHeuristic
object
1 property
_types.aggregations.TermsAggregation
_types.analysis.IcuCollationAlternate
string
_types.analysis.IcuNormalizationMode
string
_types.query_dsl.ConstantScoreQuery
_types.query_dsl.DateRangeQuery
_types.Indices
_types.query_dsl.MatchPhraseQuery
_types.query_dsl.FunctionBoostMode
string
indices._types.IndexRoutingRebalanceOptions
string
_types.query_dsl.DateDecayFunction
_types.query_dsl.DecayFunctionBasedoubledouble
object
1 property
_types.analysis.TokenChar
string
_types.query_dsl.HasParentQuery
_types.query_dsl.SpanMultiTermQuery
_types.SortOrder
string
_types.analysis.MappingCharFilter
_types.analysis.IndonesianAnalyzer
object
4 properties
1 required
_types.analysis.CharFilterBase
object
1 property
_types.analysis.IrishAnalyzer
object
4 properties
1 required
_types.query_dsl.RankFeatureQuery
_types.analysis.PortugueseAnalyzer
object
4 properties
1 required
_types.aggregations.HoltMovingAverageAggregation
indices._types.Storage
object
3 properties
1 required
_types.analysis.DelimitedPayloadTokenFilter
_types.analysis.SynonymTokenFilter
_types.query_dsl.SpanFirstQuery
indices._types.Queries
object
1 property
_types.query_dsl.MatchBoolPrefixQuery
_types.RuleRetriever
_types.analysis.DutchStemTokenFilter
_types.analysis.FinnishAnalyzer
object
4 properties
1 required
indices._types.IndexingSlowlogTresholds
object
1 property
_types.analysis.StopWordLanguage
string
_types.query_dsl.FieldValueFactorModifier
string
_types.GeoHashPrecision
A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m".
_types.analysis.FingerprintTokenFilter
_types.analysis.LetterTokenizer
_types.Fields
_types.analysis.IcuTransformDirection
string
_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.query_dsl.SpanNearQuery
_global.search._types.ScoreMode
string
_types.aggregations.PercentageScoreHeuristic
object
_types.analysis.StopTokenFilter
_types.analysis.ThaiTokenizer
_types.analysis.PatternAnalyzer
object
7 properties
1 required
_types.query_dsl.IntervalsFuzzy
object
6 properties
1 required
_types.aggregations.MutualInformationHeuristic
object
2 properties
_types.analysis.IcuFoldingTokenFilter
snapshot.repository_analyze.ReadBlobDetails
object
9 properties
3 required
_types.aggregations.GeoLineAggregation
object
5 properties
1 required
_types.analysis.PatternReplaceCharFilter
_types.analysis.HtmlStripCharFilter
_types.PinnedRetriever
_types.RRFRetrieverComponent
object
Wraps a retriever with an optional weight for RRF scoring.
2 properties
1 required
_types.analysis.PhoneticEncoder
string
snapshot._types.SourceOnlyRepositorySettings
The delegated repository type. Source repositories can use settings properties for its delegated repository type.
_types.analysis.DutchAnalyzer
object
4 properties
1 required
indices._types.SettingsSimilarityScripted
object
3 properties
2 required
indices._types.IndexSettingsLifecycleStep
object
1 property
_types.ScriptField
object
2 properties
1 required
_types.analysis.SnowballAnalyzer
object
4 properties
2 required
_types.analysis.SoraniNormalizationTokenFilter
_types.analysis.FrenchAnalyzer
object
4 properties
1 required
_types.query_dsl.CombinedFieldsOperator
string
_types.aggregations.EwmaMovingAverageAggregation
_types.aggregations.AutoDateHistogramAggregation
_types.analysis.ThaiAnalyzer
object
3 properties
1 required
_types.aggregations.PercentileRanksAggregation
snapshot.cleanup_repository.CleanupRepositoryResults
object
2 properties
2 required
_types.query_dsl.Operator
string
_types.query_dsl.RuleQuery
indices._types.MappingLimitSettingsSourceFields
object
1 property
1 required
_types.analysis.HindiAnalyzer
object
4 properties
1 required
ml._types.ClassificationInferenceOptions
object
5 properties
_types.query_dsl.RankFeatureFunctionLinear
_types.RrfRank
_types.aggregations.PipelineAggregationBase
_types.analysis.ApostropheTokenFilter
_types.KnnSearch
object
12 properties
1 required
_types.query_dsl.FunctionScoreQuery
_types.analysis.BasqueAnalyzer
object
4 properties
1 required
indices._types.SlowlogTresholds
object
2 properties
snapshot._types.ShardsStatsSummary
object
5 properties
4 required
snapshot._types.FileCountSnapshotStats
object
2 properties
2 required
_types.analysis.EstonianAnalyzer
object
3 properties
1 required
_types.mapping.CompositeSubField
object
1 property
1 required
_types.analysis.LatvianAnalyzer
object
4 properties
1 required
_types.query_dsl.GeoShapeQuery
_types.analysis.SynonymGraphTokenFilter
indices._types.SearchIdle
object
1 property
snapshot._types.AzureRepository
_types.aggregations.MovingFunctionAggregation
_types.query_dsl.FieldAndFormat
object
A reference to a field with formatting instructions on how to return the value
3 properties
1 required
_types.GeoHexCell
string
A map hex cell (H3) reference
indices._types.IndexSettingBlocks
object
5 properties
snapshot.repository_analyze.WriteSummaryInfo
object
7 properties
7 required
_types.aggregations.TopMetricsAggregation
_types.analysis.PatternCaptureTokenFilter
_types.GeoHashLocation
object
1 property
1 required
_types.analysis.WordDelimiterTokenFilter
_types.SortOptions
object
4 properties
indices._types.IndexSettings
object
57 properties
_types.aggregations.BoxplotAggregation
snapshot._types.ShardsStats
object
6 properties
6 required
_types.analysis.PredicateTokenFilter
_types.ByteSize
_types.analysis.SwedishAnalyzer
object
4 properties
1 required
_types.query_dsl.TermsQuery
snapshot.repository_analyze.SummaryInfo
object
2 properties
2 required
_global.search._types.BoundaryScanner
string
_types.ScoreNormalizer
string
_types.analysis.IcuNormalizationCharFilter
_types.aggregations.GeohexGridAggregation
_types.Field
string
Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
indices._types.SettingsQueryString
object
1 property
1 required
_types.analysis.NGramTokenFilter
_types.query_dsl.RankFeatureFunctionSaturation
_types.aggregations.StatsAggregation
_types.analysis.ElisionTokenFilter
_types.analysis.LithuanianAnalyzer
object
4 properties
1 required
_types.GeoDistanceSort
object
6 properties
_types.DateMath
string
_types.analysis.KeywordMarkerTokenFilter
_types.mapping.RuntimeFields
object
snapshot.repository_analyze.SnapshotNodeInfo
object
2 properties
2 required
_types.TimeZone
string
_types.analysis.KeywordTokenizer
_types.query_dsl.MatchPhrasePrefixQuery
_types.analysis.KeepTypesMode
string
_types.aggregations.CartesianCentroidAggregation
_types.Embedding
object
3 properties
1 required
_types.analysis.TokenFilter
_types.analysis.CustomAnalyzer
object
6 properties
2 required
_types.analysis.EdgeNGramTokenizer
_types.query_dsl.SpanTermQuery
_types.CoordsGeoBounds
object
4 properties
4 required
_types.query_dsl.MultiMatchQuery
_types.analysis.BrazilianStemTokenFilter
_types.InferenceStringGroup
_types.query_dsl.GeoExecution
string
_types.aggregations.MetricAggregationBase
object
3 properties
_types.ExpandWildcard
string
_types.query_dsl.UntypedDistanceFeatureQuery
snapshot._types.SnapshotSort
string
_types.Script
object
5 properties
_types.query_dsl.ChildScoreMode
string
indices._types.SlowlogTresholdLevels
object
4 properties
snapshot._types.ShardsStatsStage
string
_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 -…
_types.analysis.AsciiFoldingTokenFilter
snapshot.restore.SnapshotRestore
object
3 properties
3 required
_types.aggregations.CompositeAggregationBase
object
6 properties
indices._types.IndexRouting
object
2 properties
_types.analysis.PersianStemTokenFilter
_types.aggregations.MatrixStatsAggregation
_types.aggregations.TTestAggregation
_types.aggregations.ScriptedHeuristic
object
1 property
1 required
_types.IBDistribution
string
_types.mapping.RuntimeFieldFetchFields
object
2 properties
1 required
_types.aggregations.FrequentItemSetsAggregation
object
5 properties
1 required
_types.aggregations.FiltersAggregation
_types.query_dsl.IntervalsAnyOf
object
2 properties
1 required
_types.aggregations.PValueHeuristic
object
2 properties
_types.analysis.DecimalDigitTokenFilter
_types.aggregations.BucketCorrelationAggregation
A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.
_types.GeoTile
string
A map tile reference, represented as {zoom}/{x}/{y}
indices._types.SlowlogSettings
object
4 properties
_types.analysis.TokenFilterDefinition
_types.analysis.ArmenianAnalyzer
object
4 properties
1 required
_global.search._types.HighlighterType
_types.WktGeoBounds
object
1 property
1 required
_types.aggregations.ChangePointAggregation
_types.mapping.RuntimeFieldType
string
_types.query_dsl.CombinedFieldsQuery
_types.TextEmbedding
object
2 properties
1 required
indices._types.IndexSettingsAnalysis
object
5 properties
_types.analysis.KuromojiReadingFormTokenFilter
_types.analysis.Normalizer
indices._types.IndexingSlowlogSettings
object
4 properties
_types.RescorerRetriever
_types.query_dsl.DistanceFeatureQuery
_types.analysis.ConditionTokenFilter
_types.analysis.WhitespaceAnalyzer
object
2 properties
1 required
_types.aggregations.CartesianBoundsAggregation
_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…
_global.search._types.SearchRequestBody
object
34 properties
_types.analysis.HungarianAnalyzer
object
4 properties
1 required
_types.analysis.IcuCollationTokenFilter
_types.TopLeftBottomRightGeoBounds
object
2 properties
2 required
_types.query_dsl.IntervalsQuery
_types.NestedSortValue
object
4 properties
1 required
_types.query_dsl.RankFeatureFunction
object
_global.search._types.SourceFilter
object
3 properties
_types.QueryVectorBuilder
object
3 properties
_types.query_dsl.SpanNotQuery
_types.analysis.NoriTokenizer
_types.analysis.IcuNormalizationType
string
snapshot._types.SourceOnlyRepositorySettingsForAzure
object
8 properties
1 required
indices._types.IndexRoutingRebalance
object
1 property
1 required
_types.aggregations.MovingAverageAggregationBase
_types.Ids
_types.query_dsl.RegexpQuery
_types.DiversifyRetrieverTypes
string
_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.analysis.FingerprintAnalyzer
object
6 properties
1 required
_types.Metadata
object
_types.aggregations.AverageAggregation
_types.GeoDistanceType
string
_types.TokenPruningConfig
object
3 properties
_types.TopRightBottomLeftGeoBounds
object
2 properties
2 required
snapshot._types.SourceOnlyRepositorySettingsForGcs
object
6 properties
2 required
indices._types.SettingsSimilarityLmj
object
2 properties
1 required
_types.query_dsl.QueryBase
object
2 properties
_types.analysis.PhoneticLanguage
string
_types.query_dsl.PercolateQuery
_types.query_dsl.IntervalsWildcard
object
3 properties
1 required
_types.aggregations.TermsExclude
_types.query_dsl.WrapperQuery
_types.query_dsl.FieldValueFactorScoreFunction
object
4 properties
1 required
_types.analysis.PatternTokenizer
_types.aggregations.TermsAggregationExecutionHint
string
_types.analysis.NoriPartOfSpeechTokenFilter
_types.analysis.RomanianAnalyzer
object
4 properties
1 required
_types.analysis.CzechAnalyzer
object
4 properties
1 required
snapshot._types.IndexDetails
object
4 properties
3 required
snapshot._types.SnapshotStats
object
5 properties
4 required
_types.analysis.TokenizerBase
object
1 property
_types.aggregations.SerialDifferencingAggregation
_types.query_dsl.QueryContainer
object
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
61 properties
_types.analysis.HindiNormalizationTokenFilter
_types.aggregations.MinimumInterval
string
_types.ScoreSort
object
1 property
indices._types.MappingLimitSettingsDepth
object
1 property
snapshot.repository_analyze.ReadSummaryInfo
object
11 properties
11 required
snapshot.repository_analyze.BlobDetails
object
8 properties
8 required
_types.query_dsl.CommonTermsQuery
_types.aggregations.BucketSortAggregation
_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.KnnQuery
_types.Fuzziness
_types.analysis.JaStopTokenFilter
_types.EmptyObject
object
For empty Class assignments
snapshot._types.GcsRepository
_types.query_dsl.PinnedDoc
object
2 properties
1 required
_types.SortMode
string
indices._types.StorageType
snapshot._types.InfoFeatureState
object
2 properties
2 required
_types.analysis.ArabicStemTokenFilter
_global.search._types.Rescore
_types.QueryVector
array
_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.query_dsl.DistanceFeatureQueryBase
_types.Name
string
_types.aggregations.SumBucketAggregation
_types.aggregations.Missing
_types.aggregations.DateHistogramAggregation
_types.query_dsl.RangeQueryBasedouble
indices._types.MappingLimitSettingsDimensionFields
object
1 property
snapshot._types.SourceOnlyRepository
_types.query_dsl.IdsQuery
_types.query_dsl.BoostingQuery
_global.search._types.HighlighterEncoder
string
_types.query_dsl.QueryStringQuery
_types.query_dsl.SpanWithinQuery
indices._types.CacheQueries
object
1 property
1 required
_types.MultiTermQueryRewrite
string
_types.analysis.RussianStemTokenFilter
_types.aggregations.WeightedAverageValue
object
3 properties
indices._types.MergeScheduler
object
2 properties
_types.query_dsl.IntervalsRegexp
object
3 properties
1 required
_types.analysis.KeywordAnalyzer
object
2 properties
1 required
indices._types.IndexingPressure
object
1 property
1 required
_types.query_dsl.DecayFunctionBaseDateMathDuration
object
1 property
_types.analysis.KeywordRepeatTokenFilter
_types.analysis.BrazilianAnalyzer
object
3 properties
1 required
_types.analysis.LowercaseNormalizer
object
1 property
1 required
_types.analysis.WhitespaceTokenizer
_global.search._types.InnerHits
object
17 properties
_types.query_dsl.SpanQuery
object
10 properties
indices._types.IndexRoutingAllocationDisk
object
1 property
_types.aggregations.TDigestExecutionHint
string
_global.search._types.RescoreQuery
object
4 properties
1 required
_types.aggregations.MissingOrder
string
_types.ExpandWildcards
_types.ScriptLanguage
_types.query_dsl.SpanGapQuery
object
Can only be used as a clause in a spannear query.
_types.analysis.WordDelimiterTokenFilterBase
_types.query_dsl.ExistsQuery
_types.analysis.EnglishAnalyzer
object
4 properties
1 required
_types.RankBase
object
_types.analysis.SynonymFormat
string
_types.RetrieverContainer
object
9 properties
_types.analysis.SpanishAnalyzer
object
4 properties
1 required
_types.VersionString
string
_types.query_dsl.ParentIdQuery
indices._types.IndexSettingsTimeSeries
object
3 properties
_types.analysis.FrenchStemTokenFilter
_types.analysis.KeepTypesTokenFilter
_types.RelationName
string
_types.query_dsl.GeoPolygonQuery
_types.query_dsl.MatchAllQuery
_types.analysis.NoriAnalyzer
object
5 properties
1 required
_types.KnnRetriever
_types.analysis.TurkishAnalyzer
object
4 properties
1 required
_types.mapping.ChunkRescorerChunkingSettings
object
6 properties
1 required
_types.aggregations.IpPrefixAggregation
snapshot._types.SnapshotShardsStatus
object
2 properties
2 required
_types.analysis.IcuCollationCaseFirst
string
_types.analysis.SnowballTokenFilter
_types.aggregations.MissingAggregation
_types.aggregations.MaxAggregation
_types.analysis.PhoneticRuleType
string
indices._types.SettingsHighlight
object
1 property
_types.analysis.UniqueTokenFilter
_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.KnnEmbeddingInput
Knn embedding input. Either a string, an object or array of objects
_types.RRFRetriever
_types.InferenceString
object
3 properties
2 required
_global.search._types.HighlightField
_types.aggregations.SumAggregation
_types.aggregations.ExtendedStatsAggregation
_types.analysis.SynonymTokenFilterBase
_types.analysis.KuromojiStemmerTokenFilter
_types.DurationValueUnitNanos
_global.search._types.LearningToRank
object
2 properties
1 required
snapshot.verify_repository.CompactNodeInfo
object
1 property
1 required
indices._types.SourceMode
string
_types.ScriptSortType
string
indices._types.IndexSettingsLifecycle
object
7 properties
_types.query_dsl.IntervalsContainer
object
8 properties
indices._types.SegmentSortMissing
string
ml._types.RegressionInferenceOptions
object
2 properties
snapshot._types.SnapshotIndexStats
object
3 properties
3 required
_types.mapping.RuntimeField
object
9 properties
1 required
indices._types.SettingsSimilarityIb
object
4 properties
4 required
_types.DFIIndependenceMeasure
string
_types.query_dsl.RandomScoreFunction
object
2 properties
_types.aggregations.MedianAbsoluteDeviationAggregation
_types.query_dsl.LikeDocument
object
8 properties
_types.aggregations.RangeAggregation
_types.analysis.IcuCollationStrength
string
_types.analysis.GermanStemTokenFilter
_types.analysis.CharFilter
_types.analysis.TruncateTokenFilter
_types.analysis.LimitTokenCountTokenFilter
_types.analysis.GermanAnalyzer
object
4 properties
1 required
_types.aggregations.SamplerAggregation
_types.query_dsl.PinnedQuery
_global.search._types.HighlighterTagsSchema
string
_types.aggregations.IpRangeAggregationRange
object
3 properties
_types.ScriptSort
object
5 properties
1 required
_types.query_dsl.FunctionScoreContainer
_types.analysis.StopAnalyzer
object
4 properties
1 required
_types.aggregations.HoltWintersType
string
_types.analysis.GalicianAnalyzer
object
4 properties
1 required
_types.ShardStatistics
object
5 properties
3 required
_types.analysis.IcuTokenizer
inference._types.EmbeddingContentFormat
string
_types.UnitNanos
number
Time unit for nanoseconds
_types.query_dsl.IntervalsAllOf
object
4 properties
1 required
_types.aggregations.RandomSamplerAggregation
_types.analysis.WordDelimiterGraphTokenFilter
_types.query_dsl.ShapeQuery
_types.analysis.CatalanAnalyzer
object
4 properties
1 required
indices._types.Translog
object
4 properties
_types.analysis.PersianAnalyzer
object
3 properties
1 required
_types.aggregations.NormalizeAggregation
_types.analysis.CjkBigramTokenFilter
_types.analysis.CharFilterDefinition
_types.aggregations.MovingAverageAggregation
_types.query_dsl.SimpleQueryStringFlags
Query flags can be either a single flag or a combination of flags, e.g. OR|AND|PREFIX
_types.Names
_types.aggregations.CompositeDateHistogramAggregation
_types.analysis.CharGroupTokenizer
_types.aggregations.CardinalityAggregation
_types.query_dsl.RangeRelation
string
_types.analysis.KuromojiTokenizer
_types.analysis.KuromojiTokenizationMode
string
_types.analysis.NGramTokenizer
_types.analysis.StemmerTokenFilter
snapshot._types.ReadOnlyUrlRepositorySettings
_types.analysis.CommonGramsTokenFilter
_types.query_dsl.DecayFunction
_types.query_dsl.PrefixQuery
_types.analysis.IcuCollationDecomposition
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.HighlightBase
object
21 properties
_types.DurationLarge
string
A date histogram interval. Similar to Duration with additional units: w (week), M (month), q (quarter) and y (year)
_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.LatLonGeoLocation
object
2 properties
2 required
_types.analysis.UaxEmailUrlTokenizer
_types.aggregations.PercentilesAggregation
_types.aggregations.NormalizeMethod
string
_types.analysis.IcuNormalizationTokenFilter
_types.aggregations.VariableWidthHistogramAggregation
object
5 properties
_types.aggregations.RateAggregation
_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.IntervalsFilter
object
9 properties
_types.aggregations.TestPopulation
object
3 properties
1 required
_types.aggregations.CustomCategorizeTextAnalyzer
object
3 properties
_types.aggregations.MultiTermsAggregation
_global.search._types.Highlight
_types.query_dsl.SpanFieldMaskingQuery
_types.analysis.ShingleTokenFilter
indices._types.TranslogDurability
string
_types.aggregations.GeoLinePoint
object
1 property
1 required
_types.aggregations.AdjacencyMatrixAggregation
_types.query_dsl.ScriptQuery
_types.query_dsl.RangeQueryBaseDateMath
indices._types.MappingLimitSettingsTotalFields
object
2 properties
indices._types.Merge
object
1 property
indices._types.IndexSettingsUnassignedNodeLeft
object
1 property
_types.query_dsl.RangeQuery
_types.Distance
string
_types.aggregations.TopMetricsValue
object
1 property
1 required
_types.aggregations.CumulativeSumAggregation
snapshot._types.AzureRepositorySettings
_types.analysis.Analyzer
_types.DurationValueUnitMillis
_types.aggregations.GeoTileGridAggregation
_types.analysis.TokenFilterBase
object
1 property
_types.query_dsl.GeoDistanceFeatureQuery
_types.query_dsl.DecayFunctionBase
object
1 property
_types.analysis.ArabicNormalizationTokenFilter
_global.search._types.HighlighterFragmenter
string
_types.analysis.BengaliAnalyzer
object
4 properties
1 required
_types.FieldValue
A field value.
_types.RankContainer
object
1 property
_types.query_dsl.IntervalsPrefix
object
3 properties
1 required
indices._types.SegmentSortOrder
string
_types.aggregations.BucketAggregationBase
Base type for bucket aggregations. These aggregations also accept sub-aggregations.
_types.aggregations.ChiSquareHeuristic
object
2 properties
2 required
_global.search._types.PointInTimeReference
object
2 properties
1 required
snapshot._types.RepositorySettingsBase
object
4 properties
snapshot._types.SharedFileSystemRepositorySettings
_types.PipelineName
string
_types.analysis.LowercaseTokenizer
_types.query_dsl.MoreLikeThisQuery
indices._types.IndexRoutingAllocationOptions
string
_types.aggregations.CompositeTermsAggregation
_types.query_dsl.RankFeatureFunctionSigmoid
_types.RescoreVector
object
1 property
1 required
_types.aggregations.TermsAggregationCollectMode
string
_types.analysis.NoriDecompoundMode
string
_types.aggregations.WeightedAverageAggregation
_types.AcknowledgedResponseBase
object
1 property
1 required
_types.analysis.SnowballLanguage
string
_types.query_dsl.Like
Text that we want similar documents for or a lookup to a document's field for the text.
snapshot._types.SourceOnlyRepositorySettingsForReadOnlyUrl
object
5 properties
2 required
_types.RRFRetrieverEntry
Either a direct RetrieverContainer (backward compatible) or an RRFRetrieverComponent with weight.
_types.aggregations.AggregationContainer
_types.MinimumShouldMatch
The minimum number of terms that should match as integer, percentage or range
_types.aggregations.FrequentItemSetsField
object
3 properties
1 required
snapshot._types.S3Repository
_types.aggregations.CategorizeTextAnalyzer
_types.query_dsl.ScriptScoreQuery
_types.aggregations.ReverseNestedAggregation
_types.analysis.Tokenizer
_types.aggregations.GeoHashGridAggregation
_types.query_dsl.NestedQuery
_types.query_dsl.TermQuery
indices._types.IndexRoutingAllocationInclude
object
2 properties
_types.analysis.StandardTokenizer
_types.aggregations.EwmaModelSettings
object
1 property
_types.aggregations.FormatMetricAggregationBase
_types.aggregations.ExtendedBoundsFieldDateMath
object
2 properties
_types.query_dsl.GeoGridQuery
_types.DistanceUnit
string
_types.query_dsl.NumberRangeQuery
_types.aggregations.AverageBucketAggregation
_types.aggregations.CardinalityExecutionMode
string
_types.aggregations.RateMode
string
_types.aggregations.CompositeGeoTileGridAggregation
snapshot._types.SourceOnlyRepositorySettingsForSharedFileSystem
object
4 properties
2 required
_types.analysis.BengaliNormalizationTokenFilter
_types.aggregations.DerivativeAggregation
_types.aggregations.CompositeHistogramAggregation
indices._types.IndexRoutingAllocation
object
4 properties
_types.aggregations.HdrMethod
object
1 property
_types.analysis.CjkWidthTokenFilter
_types.VersionNumber
number
_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.FunctionScoreMode
string
indices._types.IndexCheckOnStartup
string
_types.analysis.ReverseTokenFilter
_types.query_dsl.GeoValidationMethod
string
_types.DFRBasicModel
string
_types.aggregations.BucketCorrelationFunctionCountCorrelation
object
1 property
1 required
_types.analysis.IcuAnalyzer
object
3 properties
3 required
snapshot._types.S3RepositorySettings
indices._types.IndexRoutingAllocationInitialRecovery
object
1 property
_types.query_dsl.LongNumberRangeQuery
indices._types.IndexVersioning
object
2 properties
_types.analysis.ClassicTokenizer
snapshot.get.SnapshotResponseItem
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…
_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.query_dsl.DistanceFeatureQueryBaseDateMathDuration
indices._types.SettingsSimilarityBm25
object
4 properties
1 required
_types.query_dsl.TermRangeQuery
_types.aggregations.DateRangeExpression
object
3 properties
_types.aggregations.ValueType
string
indices._types.SettingsAnalyze
object
1 property
_global.search._types.Suggester
object
1 property
_types.aggregations.GeoBoundsAggregation
_types.analysis.SerbianNormalizationTokenFilter
_types.LinearRetriever
_types.analysis.CzechStemTokenFilter
_types.analysis.LowercaseTokenFilterLanguages
string
_types.LookupQueryVectorBuilder
object
4 properties
3 required
_types.query_dsl.MatchNoneQuery
_types.query_dsl.UntypedDecayFunction
_types.aggregations.SimpleMovingAverageAggregation
_types.mapping.OnScriptError
string
_types.query_dsl.ZeroTermsQuery
string
_types.analysis.GreekAnalyzer
object
3 properties
1 required
_types.uint
number
_types.RetrieverBase
object
3 properties
_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.aggregations.TDigest
object
2 properties
_types.analysis.GermanNormalizationTokenFilter
_types.VersionType
string
_types.analysis.ItalianAnalyzer
object
4 properties
1 required
indices._types.SettingsSimilarityLmd
object
2 properties
1 required
_types.StandardRetriever
_types.aggregations.GeoDistanceAggregation
_types.aggregations.RareTermsAggregation
_types.aggregations.ExtendedBoundsdouble
object
2 properties
_types.aggregations.BucketScriptAggregation
indices._types.MappingLimitSettings
object
Mapping Limit Settings
9 properties
indices._types.SettingsSimilarity
_types.aggregations.TermsInclude
_types.aggregations.LinearMovingAverageAggregation
_types.aggregations.ValueCountAggregation
snapshot._types.RepositoryBase
object
1 property
_types.analysis.EdgeNGramSide
string
_types.query_dsl.HasChildQuery
_types.analysis.ScandinavianFoldingTokenFilter
_types.query_dsl.DateDistanceFeatureQuery
indices._types.SettingsSearch
object
2 properties
_types.aggregations.GlobalAggregation
_types.aggregations.Aggregation
object
_types.analysis.StandardAnalyzer
object
4 properties
1 required
_types.analysis.LowercaseTokenFilter
_types.query_dsl.SpanOrQuery
_types.aggregations.TimeSeriesAggregation
_types.query_dsl.BoolQuery
_types.SpecifiedDocument
object
2 properties
1 required
_types.query_dsl.SimpleQueryStringQuery
indices._types.IndexingPressureMemory
object
1 property
_types.aggregations.InferenceConfigContainer
object
2 properties
_types.SortCombinations
_types.aggregations.GapPolicy
string
_types.analysis.FlattenGraphTokenFilter
_types.analysis.LengthTokenFilter
_types.analysis.PatternReplaceTokenFilter
_types.query_dsl.RangeQueryBasestring
_types.query_dsl.ScriptScoreFunction
object
1 property
1 required
_types.aggregations.DiversifiedSamplerAggregation
_types.aggregations.NestedAggregation
_types.analysis.CjkBigramIgnoredScript
string
indices._types.IndexSegmentSort
object
4 properties
_types.aggregations.CalendarInterval
string
_types.ScriptSource
snapshot._types.SnapshotInfo
object
21 properties
3 required
_types.analysis.KeepWordsTokenFilter
snapshot._types.GcsRepositorySettings
_types.analysis.NorwegianAnalyzer
object
4 properties
1 required
_types.aggregations.CompositeAggregateKey
object
_types.Normalization
string
_types.analysis.RemoveDuplicatesTokenFilter
_types.query_dsl.MatchQuery
_types.aggregations.CumulativeCardinalityAggregation
_types.analysis.EdgeNGramTokenFilter
indices._types.SettingsSimilarityDfi
object
2 properties
2 required
_types.DFRAfterEffect
string
_types.query_dsl.SimpleQueryStringFlag
string
_types.query_dsl.WeightedTokensQuery
_types.Routing
Only to be used in query and path parameters, as the array form is actually a csv
_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.MinBucketAggregation
_types.analysis.RussianAnalyzer
object
4 properties
1 required
indices._types.MappingLimitSettingsNestedObjects
object
1 property
_types.aggregations.GeoCentroidAggregation
_types.query_dsl.IntervalsRange
object
6 properties
_types.analysis.PathHierarchyTokenizer
_global.search._types.ScriptRescore
object
1 property
1 required
_types.analysis.ChineseAnalyzer
object
3 properties
1 required
_types.query_dsl.RankFeatureFunctionLogarithm
_types.query_dsl.GeoDistanceQuery
_types.analysis.SerbianAnalyzer
object
4 properties
1 required
_types.query_dsl.GeoDecayFunction
_types.aggregations.BucketCorrelationFunction
object
1 property
1 required
_types.analysis.PorterStemTokenFilter
_types.analysis.IcuTransformTokenFilter
_types.analysis.PhoneticTokenFilter
_types.IBLambda
string
_types.query_dsl.IntervalsMatch
object
6 properties
1 required
_types.aggregations.PercentilesBucketAggregation
_types.ChunkRescorer
object
2 properties
_types.analysis.SoraniAnalyzer
object
4 properties
1 required
inference._types.EmbeddingContentType
string
_types.aggregations.IpRangeAggregation
_types.analysis.KStemTokenFilter
snapshot._types.ReadOnlyUrlRepository
_types.aggregations.AggregateOrder
_types.aggregations.MinAggregation
_types.aggregations.CompositeAggregationSource
object
4 properties
_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
_types.aggregations.HoltLinearModelSettings
object
2 properties
indices._types.MappingLimitSettingsNestedFields
object
1 property
_types.UnitMillis
number
Time unit for milliseconds
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Stack (ELK Stack) 12
Other APIs Elastic Stack (ELK 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
#Snapshot
Where this information came from
This is an independent, third-party profile of Elastic Stack (ELK Stack) Snapshot 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.