Elastic Stack (ELK Stack) Migration API

openapi: 3.2.0
info:
  title: Elasticsearch Request & Response Specification Migration API
  license:
    name: Apache 2.0
    url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE
  version: ''
tags:
- name: migration
paths:
  /_migration/reindex/{index}/_cancel:
    post:
      tags:
      - migration
      summary: Cancel a migration reindex operation
      description: Cancel a migration reindex attempt for a data stream or index.
      operationId: indices-cancel-migrate-reindex
      parameters:
      - in: path
        name: index
        description: The index or data stream name
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Indices'
        style: simple
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_types.AcknowledgedResponseBase'
      x-state: Generally available; Added in 8.18.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_create_from/{source}/{dest}:
    put:
      tags:
      - migration
      summary: Create an index from a source index
      description: Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.
      externalDocs:
        description: Creating an index from source
        url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/create-index-from-source
      operationId: indices-create-from
      parameters:
      - $ref: '#/components/parameters/indices.create_from-source'
      - $ref: '#/components/parameters/indices.create_from-dest'
      requestBody:
        $ref: '#/components/requestBodies/indices.create_from'
      responses:
        '200':
          $ref: '#/components/responses/indices.create_from-200'
      x-state: Generally available; Added in 8.18.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
    post:
      tags:
      - migration
      summary: Create an index from a source index
      description: Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.
      externalDocs:
        description: Creating an index from source
        url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/create-index-from-source
      operationId: indices-create-from-1
      parameters:
      - $ref: '#/components/parameters/indices.create_from-source'
      - $ref: '#/components/parameters/indices.create_from-dest'
      requestBody:
        $ref: '#/components/requestBodies/indices.create_from'
      responses:
        '200':
          $ref: '#/components/responses/indices.create_from-200'
      x-state: Generally available; Added in 8.18.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_migration/reindex/{index}/_status:
    get:
      tags:
      - migration
      summary: Get the migration reindexing status
      description: Get the status of a migration reindex attempt for a data stream or index.
      operationId: indices-get-migrate-reindex-status
      parameters:
      - in: path
        name: index
        description: The index or data stream name.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Indices'
        style: simple
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  start_time:
                    allOf:
                    - $ref: '#/components/schemas/_types.DateTime'
                  start_time_millis:
                    allOf:
                    - $ref: '#/components/schemas/_types.EpochTimeUnitMillis'
                  complete:
                    type: boolean
                  total_indices_in_data_stream:
                    type: number
                  total_indices_requiring_upgrade:
                    type: number
                  successes:
                    type: number
                  in_progress:
                    type: array
                    items:
                      $ref: '#/components/schemas/indices.get_migrate_reindex_status.StatusInProgress'
                  pending:
                    type: number
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/indices.get_migrate_reindex_status.StatusError'
                  exception:
                    type: string
                required:
                - start_time_millis
                - complete
                - total_indices_in_data_stream
                - total_indices_requiring_upgrade
                - successes
                - in_progress
                - pending
                - errors
      x-state: Generally available; Added in 8.18.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_migration/reindex:
    post:
      tags:
      - migration
      summary: Reindex legacy backing indices
      description: 'Reindex all legacy backing indices for a data stream.

        This operation occurs in a persistent task.

        The persistent task ID is returned immediately and the reindexing work is completed in that task.'
      externalDocs:
        description: About reindexing data streams
        url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/reindex-data-stream
      operationId: indices-migrate-reindex
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/indices.migrate_reindex.MigrateReindex'
            examples:
              IndicesMigrateReindexExample1:
                description: An example body for a `POST _migration/reindex` request.
                value: "{\n    \"source\": {\n        \"index\": \"my-data-stream\"\n    },\n    \"mode\": \"upgrade\"\n}"
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_types.AcknowledgedResponseBase'
      x-state: Generally available; Added in 8.18.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_migration/deprecations:
    get:
      tags:
      - migration
      summary: Get deprecation information
      description: 'Returns information about deprecated features which are in use in the cluster.

        The reported features include cluster, node, and index level settings that will be removed or changed in the next major version.

        You must address the reported issues before upgrading to the next major version.

        However, no action is required when upgrading within the current major version.

        Deprecated features remain fully supported and will continue to work in the current version, and when upgrading to a newer minor or patch release in the same major version.

        Use this API to review your usage of these features and migrate away from them at your own pace, before upgrading to a new major version.


        > info

        > This API is designed for indirect use by the [Upgrade Assistant](https://www.elastic.co/docs/deploy-manage/upgrade/prepare-to-upgrade/upgrade-assistant).

        > We recommend learning about deprecated features using the Upgrade Assistant rather than calling this API directly.


        ## Required authorization


        * Cluster privileges: `manage`

        '
      operationId: migration-deprecations
      responses:
        '200':
          $ref: '#/components/responses/migration.deprecations-200'
      x-state: Generally available; Added in 6.1.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /{index}/_migration/deprecations:
    get:
      tags:
      - migration
      summary: Get deprecation information
      description: 'Returns information about deprecated features which are in use in the cluster.

        The reported features include cluster, node, and index level settings that will be removed or changed in the next major version.

        You must address the reported issues before upgrading to the next major version.

        However, no action is required when upgrading within the current major version.

        Deprecated features remain fully supported and will continue to work in the current version, and when upgrading to a newer minor or patch release in the same major version.

        Use this API to review your usage of these features and migrate away from them at your own pace, before upgrading to a new major version.


        > info

        > This API is designed for indirect use by the [Upgrade Assistant](https://www.elastic.co/docs/deploy-manage/upgrade/prepare-to-upgrade/upgrade-assistant).

        > We recommend learning about deprecated features using the Upgrade Assistant rather than calling this API directly.


        ## Required authorization


        * Cluster privileges: `manage`

        '
      operationId: migration-deprecations-1
      parameters:
      - $ref: '#/components/parameters/migration.deprecations-index'
      responses:
        '200':
          $ref: '#/components/responses/migration.deprecations-200'
      x-state: Generally available; Added in 6.1.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_migration/system_features:
    get:
      tags:
      - migration
      summary: Get feature migration information
      description: 'Version upgrades sometimes require changes to how features store configuration information and data in system indices.

        Check which features need to be migrated and the status of any migrations that are in progress.


        TIP: This API is designed for indirect use by the Upgrade Assistant.

        You are strongly recommended to use the Upgrade Assistant.


        ## Required authorization


        * Index privileges: `manage`

        * Cluster privileges: `manage`

        '
      operationId: migration-get-feature-upgrade-status
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  features:
                    type: array
                    items:
                      $ref: '#/components/schemas/migration.get_feature_upgrade_status.MigrationFeature'
                  migration_status:
                    allOf:
                    - $ref: '#/components/schemas/migration.get_feature_upgrade_status.MigrationStatus'
                required:
                - features
                - migration_status
              examples:
                GetFeatureUpgradeStatusResponseExample1:
                  description: A successful response from `GET /_migration/system_features`.
                  value: "{\n  \"features\" : [\n    {\n      \"feature_name\" : \"async_search\",\n      \"minimum_index_version\" : \"8100099\",\n      \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n      \"indices\" : [ ]\n    },\n    {\n      \"feature_name\" : \"enrich\",\n      \"minimum_index_version\" : \"8100099\",\n      \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n      \"indices\" : [ ]\n    },\n    {\n      \"feature_name\" : \"ent_search\",\n      \"minimum_index_version\" : \"8100099\",\n      \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n      \"indices\" : [ ]\n    },\n    {\n      \"feature_name\" : \"fleet\",\n      \"minimum_index_version\" : \"8100099\",\n      \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n      \"indices\" : [ ]\n    },\n    {\n      \"feature_name\" : \"geoip\",\n      \"minimum_index_version\" : \"8100099\",\n      \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n      \"indices\" : [ ]\n    },\n    {\n      \"feature_name\" : \"kibana\",\n      \"minimum_index_version\" : \"8100099\",\n      \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n      \"indices\" : [ ]\n    },\n    {\n      \"feature_name\" : \"logstash_management\",\n      \"minimum_index_version\" : \"8100099\",\n      \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n      \"indices\" : [ ]\n    },\n    {\n      \"feature_name\" : \"machine_learning\",\n      \"minimum_index_version\" : \"8100099\",\n      \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n      \"indices\" : [ ]\n    },\n    {\n      \"feature_name\" : \"searchable_snapshots\",\n      \"minimum_index_version\" : \"8100099\",\n      \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n      \"indices\" : [ ]\n    },\n    {\n      \"feature_name\" : \"security\",\n      \"minimum_index_version\" : \"8100099\",\n      \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n      \"indices\" : [ ]\n    },\n    {\n      \"feature_name\" : \"synonyms\",\n      \"minimum_index_version\" : \"8100099\",\n      \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n      \"indices\" : [ ]\n    },\n    {\n      \"feature_name\" : \"tasks\",\n      \"minimum_index_version\" : \"8100099\",\n      \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n      \"indices\" : [ ]\n    },\n    {\n      \"feature_name\" : \"transform\",\n      \"minimum_index_version\" : \"8100099\",\n      \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n      \"indices\" : [ ]\n    },\n    {\n      \"feature_name\" : \"watcher\",\n      \"minimum_index_version\" : \"8100099\",\n      \"migration_status\" : \"NO_MIGRATION_NEEDED\",\n      \"indices\" : [ ]\n    }\n  ],\n  \"migration_status\" : \"NO_MIGRATION_NEEDED\"\n}"
      x-state: Generally available; Added in 7.16.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
    post:
      tags:
      - migration
      summary: Start the feature migration
      description: 'Version upgrades sometimes require changes to how features store configuration information and data in system indices.

        This API starts the automatic migration process.


        Some functionality might be temporarily unavailable during the migration process.


        TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.


        ## Required authorization


        * Index privileges: `manage`

        * Cluster privileges: `manage`

        '
      operationId: migration-post-feature-upgrade
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  accepted:
                    type: boolean
                  features:
                    type: array
                    items:
                      $ref: '#/components/schemas/migration.post_feature_upgrade.MigrationFeature'
                  reason:
                    type: string
                required:
                - accepted
              examples:
                PostFeatureUpgradeResponseExample1:
                  description: 'When you run `POST /_migration/system_features` to start the migration process, the response lists the features that will be migrated.

                    '
                  value: "{\n  \"accepted\" : true,\n  \"features\" : [\n    {\n      \"feature_name\" : \"security\"\n    }\n  ]\n}"
      x-state: Generally available; Added in 7.16.0
      x-metaTags:
      - content: Elasticsearch
        name: product_name
components:
  schemas:
    _types.query_dsl.SpanContainingQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          big:
            description: 'Can be any span query.

              Matching spans from `big` that contain matches from `little` are returned.'
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.SpanQuery'
          little:
            description: 'Can be any span query.

              Matching spans from `big` that contain matches from `little` are returned.'
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.SpanQuery'
        required:
        - big
        - little
    _types.query_dsl.TypeQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          value:
            type: string
        required:
        - value
    _types.analysis.MinHashTokenFilter:
      allOf:
      - $ref: '#/components/schemas/_types.analysis.TokenFilterBase'
      - type: object
        properties:
          type:
            type: string
            enum:
            - min_hash
          bucket_count:
            description: Number of buckets to which hashes are assigned. Defaults to `512`.
            type: number
          hash_count:
            description: Number of ways to hash each token in the stream. Defaults to `1`.
            type: number
          hash_set_size:
            description: 'Number of hashes to keep from each bucket. Defaults to `1`.

              Hashes are retained by ascending size, starting with the bucket’s smallest hash first.'
            type: number
          with_rotation:
            description: If `true`, the filter fills empty buckets with the value of the first non-empty bucket to its circular right if the `hash_set_size` is `1`. If the `bucket_count` argument is greater than 1, this parameter defaults to `true`. Otherwise, this parameter defaults to `false`.
            type: boolean
        required:
        - type
    _types.aggregations.TopHitsAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase'
      - type: object
        properties:
          docvalue_fields:
            description: Fields for which to return doc values.
            type: array
            items:
              $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat'
          explain:
            description: If `true`, returns detailed information about score computation as part of a hit.
            default: false
            type: boolean
          fields:
            description: 'Array of wildcard (*) patterns. The request returns values for field names

              matching these patterns in the hits.fields property of the response.'
            type: array
            items:
              $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat'
          from:
            description: Starting document offset.
            default: 0.0
            type: number
          highlight:
            description: Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results.
            allOf:
            - $ref: '#/components/schemas/_global.search._types.Highlight'
          script_fields:
            description: Returns the result of one or more script evaluations for each hit.
            type: object
            additionalProperties:
              $ref: '#/components/schemas/_types.ScriptField'
          size:
            description: The maximum number of top matching hits to return per bucket.
            default: 3.0
            type: number
          sort:
            description: 'Sort order of the top matching hits.

              By default, the hits are sorted by the score of the main query.'
            allOf:
            - $ref: '#/components/schemas/_types.Sort'
          _source:
            description: Selects the fields of the source that are returned.
            allOf:
            - $ref: '#/components/schemas/_global.search._types.SourceConfig'
          stored_fields:
            description: Returns values for the specified stored fields (fields that use the `store` mapping option).
            allOf:
            - $ref: '#/components/schemas/_types.Fields'
          track_scores:
            description: If `true`, calculates and returns document scores, even if the scores are not used for sorting.
            default: false
            type: boolean
          version:
            description: If `true`, returns document version as part of a hit.
            default: false
            type: boolean
          seq_no_primary_term:
            description: If `true`, returns sequence number and primary term of the last modification of each hit.
            type: boolean
    _types.query_dsl.CombinedFieldsZeroTerms:
      type: string
      enum:
      - none
      - all
    _types.aggregations.BucketSelectorAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
        properties:
          script:
            description: The script to run for this aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.Script'
    _types.analysis.HunspellTokenFilter:
      allOf:
      - $ref: '#/components/schemas/_types.analysis.TokenFilterBase'
      - type: object
        properties:
          type:
            type: string
            enum:
            - hunspell
          dedup:
            description: If `true`, duplicate tokens are removed from the filter’s output. Defaults to `true`.
            type: boolean
          dictionary:
            description: 'One or more `.dic` files (e.g, `en_US.dic`, my_custom.dic) to use for the Hunspell dictionary.

              By default, the `hunspell` filter uses all `.dic` files in the `<$ES_PATH_CONF>/hunspell/<locale>` directory specified using the `lang`, `language`, or `locale` parameter.'
            type: string
          locale:
            description: Locale directory used to specify the `.aff` and `.dic` files for a Hunspell dictionary.
            type: string
          longest_only:
            description: If `true`, only the longest stemmed version of each token is included in the output. If `false`, all stemmed versions of the token are included. Defaults to `false`.
            type: boolean
        required:
        - type
        - locale
    _types.mapping.VersionProperty:
      allOf:
      - $ref: '#/components/schemas/_types.mapping.DocValuesPropertyBase'
      - type: object
        properties:
          type:
            type: string
            enum:
            - version
        required:
        - type
    _types.mapping.MatchType:
      type: string
      enum:
      - simple
      - regex
    _types.aggregations.TermsPartition:
      type: object
      properties:
        num_partitions:
          description: The number of partitions.
          type: number
        partition:
          description: The partition number for this request.
          type: number
      required:
      - num_partitions
      - partition
    _types.query_dsl.GeoBoundingBoxQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          type:
            deprecated: true
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.GeoExecution'
          validation_method:
            description: 'Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.

              Set to `COERCE` to also try to infer correct latitude or longitude.'
            default: '''strict'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.GeoValidationMethod'
          ignore_unmapped:
            description: 'Set to `true` to ignore an unmapped field and not match any documents for this query.

              Set to `false` to throw an exception if the field is not mapped.'
            default: false
            type: boolean
    _types.analysis.DanishAnalyzer:
      type: object
      properties:
        type:
          type: string
          enum:
          - danish
        stopwords:
          allOf:
          - $ref: '#/components/schemas/_types.analysis.StopWords'
        stopwords_path:
          type: string
      required:
      - type
    _types.SortResults:
      type: array
      items:
        $ref: '#/components/schemas/_types.FieldValue'
    indices._types.SoftDeletes:
      type: object
      properties:
        enabled:
          description: Indicates whether soft deletes are enabled on the index.
          default: true
          type: boolean
        retention_lease:
          description: 'The maximum period to retain a shard history retention lease before it is considered expired.

            Shard history retention leases ensure that soft deletes are retained during merges on the Lucene

            index. If a soft delete is merged away before it can be replicated to a follower the following

            process will fail due to incomplete history on the leader.'
          allOf:
          - $ref: '#/components/schemas/indices._types.RetentionLease'
    _types.mapping.CorePropertyBase:
      allOf:
      - $ref: '#/components/schemas/_types.mapping.PropertyBase'
      - type: object
        properties:
          copy_to:
            allOf:
            - $ref: '#/components/schemas/_types.Fields'
          store:
            type: boolean
    _types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator:
      type: object
      properties:
        doc_count:
          description: 'The total number of documents that initially created the expectations. It’s required to be greater

            than or equal to the sum of all values in the buckets_path as this is the originating superset of data

            to which the term values are correlated.'
          type: number
        expectations:
          description: 'An array of numbers with which to correlate the configured `bucket_path` values.

            The length of this value must always equal the number of buckets returned by the `bucket_path`.'
          type: array
          items:
            type: number
        fractions:
          description: 'An array of fractions to use when averaging and calculating variance. This should be used if

            the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided,

            must equal expectations.'
          type: array
          items:
            type: number
      required:
      - doc_count
      - expectations
    indices._types.SegmentSortMode:
      type: string
      enum:
      - min
      - MIN
      - max
      - MAX
    _types.analysis.KuromojiAnalyzer:
      type: object
      properties:
        type:
          type: string
          enum:
          - kuromoji
        mode:
          allOf:
          - $ref: '#/components/schemas/_types.analysis.KuromojiTokenizationMode'
        user_dictionary:
          type: string
      required:
      - type
    _types.aggregations.ChildrenAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          type:
            description: The child type that should be selected.
            allOf:
            - $ref: '#/components/schemas/_types.RelationName'
    _types.EpochTimeUnitMillis:
      allOf:
      - $ref: '#/components/schemas/_types.UnitMillis'
    _types.aggregations.MatrixAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.Aggregation'
      - type: object
        properties:
          fields:
            description: An array of fields for computing the statistics.
            allOf:
            - $ref: '#/components/schemas/_types.Fields'
          missing:
            description: 'The value to apply to documents that do not have a value.

              By default, documents without a value are ignored.'
            type: object
            additionalProperties:
              type: number
    _types.query_dsl.DisMaxQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          queries:
            description: 'One or more query clauses.

              Returned documents must match one or more of these queries.

              If a document matches multiple queries, Elasticsearch uses the highest relevance score.'
            type: array
            items:
              $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          tie_breaker:
            description: Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses.
            default: 0.0
            type: number
        required:
        - queries
    _types.mapping.IntegerNumberProperty:
      allOf:
      - $ref: '#/components/schemas/_types.mapping.NumberPropertyBase'
      - type: object
        properties:
          type:
            type: string
            enum:
            - integer
          null_value:
            type: number
        required:
        - type
    _types.aggregations.SamplerAggregationExecutionHint:
      type: string
      enum:
      - map
      - global_ordinals
      - bytes_hash
    _types.aggregations.MovingPercentilesAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
        properties:
          window:
            description: The size of window to "slide" across the histogram.
            type: number
          shift:
            description: 'By default, the window consists of the last n values excluding the current bucket.

              Increasing `shift` by 1, moves the starting window position by 1 to the right.'
            default: 0.0
            type: number
          keyed:
            type: boolean
    _types.aggregations.HoltWintersModelSettings:
      type: object
      properties:
        alpha:
          type: number
        beta:
          type: number
        gamma:
          type: number
        pad:
          type: boolean
        period:
          type: number
        type:
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.HoltWintersType'
    _types.aggregations.HistogramAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          extended_bounds:
            description: Enables extending the bounds of the histogram beyond the data itself.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ExtendedBoundsdouble'
          hard_bounds:
            description: 'Limits the range of buckets in the histogram.

              It is particularly useful in the case of open data ranges that can result in a very large number of buckets.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ExtendedBoundsdouble'
          field:
            description: The name of the field to aggregate on.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          interval:
            description: 'The interval for the buckets.

              Must be a positive decimal.'
            type: number
          min_doc_count:
            description: 'Only returns buckets that have `min_doc_count` number of documents.

              By default, the response will fill gaps in the histogram with empty buckets.'
            type: number
          missing:
            description: 'The value to apply to documents that do not have a value.

              By default, documents without a value are ignored.'
            type: number
          offset:
            description: 'By default, the bucket keys start with 0 and then continue in even spaced steps of `interval`.

              The bucket boundaries can be shifted by using the `offset` option.'
            type: number
          order:
            description: 'The sort order of the returned buckets.

              By default, the returned buckets are sorted by their key ascending.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.AggregateOrder'
          script:
            allOf:
            - $ref: '#/components/schemas/_types.Script'
          format:
            type: string
          keyed:
            description: If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys.
            default: false
            type: boolean
    _types.GeoTilePrecision:
      type: number
    _types.analysis.CompoundWordTokenFilterBase:
      allOf:
      - $ref: '#/components/schemas/_types.analysis.TokenFilterBase'
      - type

# --- truncated at 32 KB (550 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-migration-api-openapi.yml