openapi: 3.2.0
info:
  title: Elasticsearch Searchable Snapshots API
  description: 'Elasticsearch provides REST APIs that are used by the UI components and can be called directly to configure and access Elasticsearch features.

    ## Documentation source and versions

    This documentation is derived from the main branch of the elasticsearch-specification repository. It is provided under license Attribution-NonCommercial-NoDerivatives 4.0 International.

    This documentation contains work-in-progress information for future Elastic Stack releases.'
  license:
    name: Apache 2.0
    url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE
  version: ''
security:
- apiKeyAuth: []
- basicAuth: []
- bearerAuth: []
tags:
- name: searchable_snapshots
  description: The searchable snapshots APIs are used to mount snapshots as searchable indices.
  externalDocs:
    description: Learn more.
    url: https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots
  x-displayName: Searchable snapshots
paths:
  /_searchable_snapshots/cache/stats:
    get:
      tags:
      - searchable_snapshots
      summary: Get cache statistics
      description: Get statistics about the shared cache for partially mounted indices.
      externalDocs:
        description: Searchable snapshots
        url: https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots
        x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-api-cache-stats.html
      operationId: searchable-snapshots-cache-stats
      parameters:
      - in: query
        name: master_timeout
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Duration'
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  nodes:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/searchable_snapshots.cache_stats.Node'
                required:
                - nodes
              examples:
                CacheStatsResponseExample1:
                  description: A successful response from `GET /_searchable_snapshots/cache/stats`.
                  value: "{\n  \"nodes\" : {\n    \"eerrtBMtQEisohZzxBLUSw\" : {\n      \"shared_cache\" : {\n        \"reads\" : 6051, // The number of cache region read operations. If reads > writes, the difference represents requests successfully served from the cache without accessing the snapshot repository.\n        \"bytes_read_in_bytes\" : 5448829,\n        \"writes\" : 37, // The number of cache region write operations. If reads == writes, every request required fetching data from the snapshot repository into the cache.\n        \"bytes_written_in_bytes\" : 1208320,\n        \"evictions\" : 5, // The number of cache region evictions. A low eviction count indicates the cache is effectively serving requests. Use this metric to evaluate cache sizing.\n        \"num_regions\" : 65536,\n        \"size_in_bytes\" : 1099511627776,\n        \"region_size_in_bytes\" : 16777216 // The size of each cache region. A region is a contiguous byte range stored on local disk.\n      }\n    }\n  }\n}"
      x-state: Technical preview; Added in 7.13.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb get\">GET</span>\n              <span class=\"operation-path\">/_searchable_snapshots/cache/stats</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage`

        '
      x-api: cache_stats.searchable_snapshots
      x-category: management
      x-codeSamples:
      - lang: Console
        source: 'GET /_searchable_snapshots/cache/stats

          '
      - lang: Python
        source: resp = client.searchable_snapshots.cache_stats()
      - lang: JavaScript
        source: const response = await client.searchableSnapshots.cacheStats();
      - lang: Ruby
        source: response = client.searchable_snapshots.cache_stats
      - lang: PHP
        source: $resp = $client->searchableSnapshots()->cacheStats();
      - lang: curl
        source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_searchable_snapshots/cache/stats"'
      - lang: Java
        source: 'client.searchableSnapshots().cacheStats(c -> c);

          '
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_searchable_snapshots/{node_id}/cache/stats:
    get:
      tags:
      - searchable_snapshots
      summary: Get cache statistics
      description: Get statistics about the shared cache for partially mounted indices.
      externalDocs:
        description: Searchable snapshots
        url: https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots
        x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-api-cache-stats.html
      operationId: searchable-snapshots-cache-stats-1
      parameters:
      - in: path
        name: node_id
        description: The names of the nodes in the cluster to target.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.NodeIds'
        style: simple
      - in: query
        name: master_timeout
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Duration'
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  nodes:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/searchable_snapshots.cache_stats.Node'
                required:
                - nodes
              examples:
                CacheStatsResponseExample1:
                  description: A successful response from `GET /_searchable_snapshots/cache/stats`.
                  value: "{\n  \"nodes\" : {\n    \"eerrtBMtQEisohZzxBLUSw\" : {\n      \"shared_cache\" : {\n        \"reads\" : 6051, // The number of cache region read operations. If reads > writes, the difference represents requests successfully served from the cache without accessing the snapshot repository.\n        \"bytes_read_in_bytes\" : 5448829,\n        \"writes\" : 37, // The number of cache region write operations. If reads == writes, every request required fetching data from the snapshot repository into the cache.\n        \"bytes_written_in_bytes\" : 1208320,\n        \"evictions\" : 5, // The number of cache region evictions. A low eviction count indicates the cache is effectively serving requests. Use this metric to evaluate cache sizing.\n        \"num_regions\" : 65536,\n        \"size_in_bytes\" : 1099511627776,\n        \"region_size_in_bytes\" : 16777216 // The size of each cache region. A region is a contiguous byte range stored on local disk.\n      }\n    }\n  }\n}"
      x-state: Technical preview; Added in 7.13.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb get\">GET</span>\n              <span class=\"operation-path\">/_searchable_snapshots/{node_id}/cache/stats</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage`

        '
      x-api: cache_stats.searchable_snapshots
      x-category: management
      x-codeSamples:
      - lang: Console
        source: 'GET /_searchable_snapshots/cache/stats

          '
      - lang: Python
        source: resp = client.searchable_snapshots.cache_stats()
      - lang: JavaScript
        source: const response = await client.searchableSnapshots.cacheStats();
      - lang: Ruby
        source: response = client.searchable_snapshots.cache_stats
      - lang: PHP
        source: $resp = $client->searchableSnapshots()->cacheStats();
      - lang: curl
        source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_searchable_snapshots/cache/stats"'
      - lang: Java
        source: 'client.searchableSnapshots().cacheStats(c -> c);

          '
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_searchable_snapshots/cache/clear:
    post:
      tags:
      - searchable_snapshots
      summary: Clear the cache
      description: Clear indices and data streams from the shared cache for partially mounted indices.
      externalDocs:
        description: Searchable snapshots
        url: https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots
        x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-api-clear-cache.html
      operationId: searchable-snapshots-clear-cache
      parameters:
      - in: query
        name: expand_wildcards
        description: "Whether to expand wildcard expression to concrete indices that are open, closed or both\n\nSupported values include:\n  - `all`: Match any data stream or index, including hidden ones.\n  - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n  - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n  - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n  - `none`: Wildcard expressions are not accepted.\n\n"
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.ExpandWildcards'
        style: form
      - in: query
        name: allow_no_indices
        description: 'Whether to ignore if a wildcard indices expression resolves into no concrete indices.

          (This includes `_all` string or when no indices have been specified)'
        deprecated: false
        schema:
          type: boolean
        style: form
      - in: query
        name: ignore_unavailable
        description: Whether specified concrete indices should be ignored when unavailable (missing or closed)
        deprecated: false
        schema:
          type: boolean
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      x-state: Technical preview; Added in 7.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb post\">POST</span>\n              <span class=\"operation-path\">/_searchable_snapshots/cache/clear</span>\n              </div>\n            "
      x-req-auth:
      - 'Index privileges: `manage`

        '
      - 'Cluster privileges: `manage`

        '
      x-api: clear_cache.searchable_snapshots
      x-category: management
      x-codeSamples:
      - lang: Console
        source: 'POST /my-index/_searchable_snapshots/cache/clear

          '
      - lang: Python
        source: "resp = client.searchable_snapshots.clear_cache(\n    index=\"my-index\",\n)"
      - lang: JavaScript
        source: "const response = await client.searchableSnapshots.clearCache({\n  index: \"my-index\",\n});"
      - lang: Ruby
        source: "response = client.searchable_snapshots.clear_cache(\n  index: \"my-index\"\n)"
      - lang: PHP
        source: "$resp = $client->searchableSnapshots()->clearCache([\n    \"index\" => \"my-index\",\n]);"
      - lang: curl
        source: 'curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/my-index/_searchable_snapshots/cache/clear"'
      - lang: Java
        source: "client.searchableSnapshots().clearCache(c -> c\n    .index(\"my-index\")\n);\n"
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /{index}/_searchable_snapshots/cache/clear:
    post:
      tags:
      - searchable_snapshots
      summary: Clear the cache
      description: Clear indices and data streams from the shared cache for partially mounted indices.
      externalDocs:
        description: Searchable snapshots
        url: https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots
        x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/searchable-snapshots-api-clear-cache.html
      operationId: searchable-snapshots-clear-cache-1
      parameters:
      - in: path
        name: index
        description: 'A comma-separated list of data streams, indices, and aliases to clear from the cache.

          It supports wildcards (`*`).'
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Indices'
        style: simple
      - in: query
        name: expand_wildcards
        description: "Whether to expand wildcard expression to concrete indices that are open, closed or both\n\nSupported values include:\n  - `all`: Match any data stream or index, including hidden ones.\n  - `open`: Match open, non-hidden indices. Also matches any non-hidden data stream.\n  - `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.\n  - `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or `both`.\n  - `none`: Wildcard expressions are not accepted.\n\n"
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.ExpandWildcards'
        style: form
      - in: query
        name: allow_no_indices
        description: 'Whether to ignore if a wildcard indices expression resolves into no concrete indices.

          (This includes `_all` string or when no indices have been specified)'
        deprecated: false
        schema:
          type: boolean
        style: form
      - in: query
        name: ignore_unavailable
        description: Whether specified concrete indices should be ignored when unavailable (missing or closed)
        deprecated: false
        schema:
          type: boolean
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      x-state: Technical preview; Added in 7.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb post\">POST</span>\n              <span class=\"operation-path\">/{index}/_searchable_snapshots/cache/clear</span>\n              </div>\n            "
      x-req-auth:
      - 'Index privileges: `manage`

        '
      - 'Cluster privileges: `manage`

        '
      x-api: clear_cache.searchable_snapshots
      x-category: management
      x-codeSamples:
      - lang: Console
        source: 'POST /my-index/_searchable_snapshots/cache/clear

          '
      - lang: Python
        source: "resp = client.searchable_snapshots.clear_cache(\n    index=\"my-index\",\n)"
      - lang: JavaScript
        source: "const response = await client.searchableSnapshots.clearCache({\n  index: \"my-index\",\n});"
      - lang: Ruby
        source: "response = client.searchable_snapshots.clear_cache(\n  index: \"my-index\"\n)"
      - lang: PHP
        source: "$resp = $client->searchableSnapshots()->clearCache([\n    \"index\" => \"my-index\",\n]);"
      - lang: curl
        source: 'curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/my-index/_searchable_snapshots/cache/clear"'
      - lang: Java
        source: "client.searchableSnapshots().clearCache(c -> c\n    .index(\"my-index\")\n);\n"
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_snapshot/{repository}/{snapshot}/_mount:
    post:
      tags:
      - searchable_snapshots
      summary: Mount a snapshot
      description: 'Mount a snapshot as a searchable snapshot index.

        Do not use this API for snapshots managed by index lifecycle management (ILM).

        Manually mounting ILM-managed snapshots can interfere with ILM processes.'
      operationId: searchable-snapshots-mount
      parameters:
      - in: path
        name: repository
        description: The name of the repository containing the snapshot of the index to mount.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Name'
        style: simple
      - in: path
        name: snapshot
        description: The name of the snapshot of the index to mount.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Name'
        style: simple
      - in: query
        name: master_timeout
        description: 'The period to wait for the master node.

          If the master node is not available before the timeout expires, the request fails and returns an error.

          To indicate that the request should never timeout, set it to `-1`.'
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Duration'
        style: form
      - in: query
        name: wait_for_completion
        description: If true, the request blocks until the operation is complete.
        deprecated: false
        schema:
          type: boolean
        style: form
      - in: query
        name: storage
        description: The mount option for the searchable snapshot index.
        deprecated: false
        schema:
          type: string
        style: form
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                index:
                  description: 'The name of the index contained in the snapshot whose data is to be mounted.

                    If no `renamed_index` is specified, this name will also be used to create the new index.'
                  allOf:
                  - $ref: '#/components/schemas/_types.IndexName'
                renamed_index:
                  description: The name of the index that will be created.
                  allOf:
                  - $ref: '#/components/schemas/_types.IndexName'
                index_settings:
                  description: The settings that should be added to the index when it is mounted.
                  type: object
                  additionalProperties:
                    type: object
                ignore_index_settings:
                  description: The names of settings that should be removed from the index when it is mounted.
                  type: array
                  items:
                    type: string
              required:
              - index
            examples:
              SearchableSnapshotsMountSnapshotRequestExample1:
                description: 'Run `POST /_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true` to mount the index `my_docs` from an existing snapshot named `my_snapshot` stored in `my_repository` as a new index `docs`.

                  '
                value: "{\n  \"index\": \"my_docs\",\n  \"renamed_index\": \"docs\",\n  \"index_settings\": {\n    \"index.number_of_replicas\": 0\n  },\n  \"ignore_index_settings\": [ \"index.refresh_interval\" ]\n}"
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  snapshot:
                    allOf:
                    - $ref: '#/components/schemas/searchable_snapshots.mount.MountedSnapshot'
                required:
                - snapshot
      x-state: Generally available; Added in 7.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb post\">POST</span>\n              <span class=\"operation-path\">/_snapshot/{repository}/{snapshot}/_mount</span>\n              </div>\n            "
      x-req-auth:
      - 'Index privileges: `manage`

        '
      - 'Cluster privileges: `manage`

        '
      x-api: mount.searchable_snapshots
      x-category: management
      x-codeSamples:
      - lang: Console
        source: "POST /_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true\n{\n  \"index\": \"my_docs\",\n  \"renamed_index\": \"docs\",\n  \"index_settings\": {\n    \"index.number_of_replicas\": 0\n  },\n  \"ignore_index_settings\": [ \"index.refresh_interval\" ]\n}"
      - lang: Python
        source: "resp = client.searchable_snapshots.mount(\n    repository=\"my_repository\",\n    snapshot=\"my_snapshot\",\n    wait_for_completion=True,\n    index=\"my_docs\",\n    renamed_index=\"docs\",\n    index_settings={\n        \"index.number_of_replicas\": 0\n    },\n    ignore_index_settings=[\n        \"index.refresh_interval\"\n    ],\n)"
      - lang: JavaScript
        source: "const response = await client.searchableSnapshots.mount({\n  repository: \"my_repository\",\n  snapshot: \"my_snapshot\",\n  wait_for_completion: \"true\",\n  index: \"my_docs\",\n  renamed_index: \"docs\",\n  index_settings: {\n    \"index.number_of_replicas\": 0,\n  },\n  ignore_index_settings: [\"index.refresh_interval\"],\n});"
      - lang: Ruby
        source: "response = client.searchable_snapshots.mount(\n  repository: \"my_repository\",\n  snapshot: \"my_snapshot\",\n  wait_for_completion: \"true\",\n  body: {\n    \"index\": \"my_docs\",\n    \"renamed_index\": \"docs\",\n    \"index_settings\": {\n      \"index.number_of_replicas\": 0\n    },\n    \"ignore_index_settings\": [\n      \"index.refresh_interval\"\n    ]\n  }\n)"
      - lang: PHP
        source: "$resp = $client->searchableSnapshots()->mount([\n    \"repository\" => \"my_repository\",\n    \"snapshot\" => \"my_snapshot\",\n    \"wait_for_completion\" => \"true\",\n    \"body\" => [\n        \"index\" => \"my_docs\",\n        \"renamed_index\" => \"docs\",\n        \"index_settings\" => [\n            \"index.number_of_replicas\" => 0,\n        ],\n        \"ignore_index_settings\" => array(\n            \"index.refresh_interval\",\n        ),\n    ],\n]);"
      - lang: curl
        source: 'curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d ''{"index":"my_docs","renamed_index":"docs","index_settings":{"index.number_of_replicas":0},"ignore_index_settings":["index.refresh_interval"]}'' "$ELASTICSEARCH_URL/_snapshot/my_repository/my_snapshot/_mount?wait_for_completion=true"'
      - lang: Java
        source: "client.searchableSnapshots().mount(m -> m\n    .ignoreIndexSettings(\"index.refresh_interval\")\n    .index(\"my_docs\")\n    .indexSettings(\"index.number_of_replicas\", JsonData.fromJson(\"0\"))\n    .renamedIndex(\"docs\")\n    .repository(\"my_repository\")\n    .snapshot(\"my_snapshot\")\n    .waitForCompletion(true)\n);\n"
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /_searchable_snapshots/stats:
    get:
      tags:
      - searchable_snapshots
      summary: Get searchable snapshot statistics
      operationId: searchable-snapshots-stats
      parameters:
      - in: query
        name: level
        description: Return stats aggregated at cluster, index or shard level
        deprecated: false
        schema:
          $ref: '#/components/schemas/searchable_snapshots._types.StatsLevel'
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  stats:
                    type: object
                  total:
                    type: object
                required:
                - stats
                - total
      x-state: Generally available; Added in 7.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb get\">GET</span>\n              <span class=\"operation-path\">/_searchable_snapshots/stats</span>\n              </div>\n            "
      x-req-auth:
      - 'Index privileges: `manage`

        '
      - 'Cluster privileges: `manage`

        '
      x-api: stats.searchable_snapshots
      x-category: management
      x-codeSamples:
      - lang: Console
        source: 'GET /my-index/_searchable_snapshots/stats

          '
      - lang: Python
        source: "resp = client.searchable_snapshots.stats(\n    index=\"my-index\",\n)"
      - lang: JavaScript
        source: "const response = await client.searchableSnapshots.stats({\n  index: \"my-index\",\n});"
      - lang: Ruby
        source: "response = client.searchable_snapshots.stats(\n  index: \"my-index\"\n)"
      - lang: PHP
        source: "$resp = $client->searchableSnapshots()->stats([\n    \"index\" => \"my-index\",\n]);"
      - lang: curl
        source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/my-index/_searchable_snapshots/stats"'
      - lang: Java
        source: "client.searchableSnapshots().stats(s -> s\n    .index(\"my-index\")\n);\n"
      x-metaTags:
      - content: Elasticsearch
        name: product_name
  /{index}/_searchable_snapshots/stats:
    get:
      tags:
      - searchable_snapshots
      summary: Get searchable snapshot statistics
      operationId: searchable-snapshots-stats-1
      parameters:
      - in: path
        name: index
        description: A comma-separated list of data streams and indices to retrieve statistics for.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Indices'
        style: simple
      - in: query
        name: level
        description: Return stats aggregated at cluster, index or shard level
        deprecated: false
        schema:
          $ref: '#/components/schemas/searchable_snapshots._types.StatsLevel'
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  stats:
                    type: object
                  total:
                    type: object
                required:
                - stats
                - total
      x-state: Generally available; Added in 7.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb get\">GET</span>\n              <span class=\"operation-path\">/{index}/_searchable_snapshots/stats</span>\n              </div>\n            "
      x-req-auth:
      - 'Index privileges: `manage`

        '
      - 'Cluster privileges: `manage`

        '
      x-api: stats.searchable_snapshots
      x-category: management
      x-codeSamples:
      - lang: Console
        source: 'GET /my-index/_searchable_snapshots/stats

          '
      - lang: Python
        source: "resp = client.searchable_snapshots.stats(\n    index=\"my-index\",\n)"
      - lang: JavaScript
        source: "const response = await client.searchableSnapshots.stats({\n  index: \"my-index\",\n});"
      - lang: Ruby
        source: "response = client.searchable_snapshots.stats(\n  index: \"my-index\"\n)"
      - lang: PHP
        source: "$resp = $client->searchableSnapshots()->stats([\n    \"index\" => \"my-index\",\n]);"
      - lang: curl
        source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/my-index/_searchable_snapshots/stats"'
      - lang: Java
        source: "client.searchableSnapshots().stats(s -> s\n    .index(\"my-index\")\n);\n"
      x-metaTags:
      - content: Elasticsearch
        name: product_name
components:
  schemas:
    _types.uint:
      type: number
    _types.ExpandWildcards:
      oneOf:
      - $ref: '#/components/schemas/_types.ExpandWildcard'
      - type: array
        items:
          $ref: '#/components/schemas/_types.ExpandWildcard'
    searchable_snapshots.cache_stats.Node:
      type: object
      properties:
        shared_cache:
          allOf:
          - $ref: '#/components/schemas/searchable_snapshots.cache_stats.Shared'
      required:
      - shared_cache
    _types.ShardStatistics:
      type: object
      properties:
        failed:
          description: The number of shards the operation or search attempted to run on but failed.
          allOf:
          - $ref: '#/components/schemas/_types.uint'
        successful:
          description: The number of shards the operation or search succeeded on.
          allOf:
          - $ref: '#/components/schemas/_types.uint'
        total:
          description: The number of shards the operation or search will run on overall.
          allOf:
          - $ref: '#/components/schemas/_types.uint'
        failures:
          type: array
          items:
            $ref: '#/components/schemas/_types.ShardFailure'
        skipped:
          allOf:
          - $ref: '#/components/schemas/_types.uint'
      required:
      - failed
      - successful
      - total
    _types.ErrorCause:
      description: '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 the error type.'
      type: object
      properties:
        type:
          description: The type of error
          type: string
        reason:
          description: A human-readable explanation of the error, in English.
          oneOf:
          - type: string
          - type:
            - string
            - 'null'
        stack_trace:
          description: The server stack trace. Present only if the `error_trace=true` parameter was sent with the request.
          type: string
        caused_by:
          allOf:
          - $ref: '#/components/schemas/_types.ErrorCause'
        root_cause:
          type: array
          items:
            $ref: '#/components/schemas/_types.ErrorCause'
        suppressed:
          type: array
          items:
            $ref: '#/components/schemas/_types.ErrorCause'
      required:
      - type
    _types.Indices:
      oneOf:
      - $ref: '#/components/schemas/_types.IndexName'
      - type: array
        items:
          $ref: '#/components/schemas/_types.IndexName'
    _types.NodeIds:
      oneOf:
      - $ref: '#/components/schemas/_types.NodeId'
      - type: array
        items:
          $ref: '#/components/schemas/_types.NodeId'
    searchable_snapshots.mount.MountedSnapshot:
      type: object
      properties:
        snapshot:
          allOf:
          - $ref: '#/components/schemas/_types.Name'
        indices:
          allOf:
          - $ref: '#/components/schemas/_types.Indices'
        shards:
          allOf:
          - $ref: '#/components/schemas/_types.ShardStatistics'
      required:
      - snapshot
      - indices
      - shards
    _types.Duration:
      externalDocs:
        url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#time-units
      description: '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 indicate an unspecified value.'
      oneOf:
      - type: string
      - type: string
        enum:
        - '-1'
      - type: string
        enum:
        - '0'
    _types.ShardFailure:
      type: object
      properties:
        index:
          allOf:
          - $ref: '#/components/schemas/_types.IndexName'
        node:
          type: string
        reason:
          allOf:
          - $ref: '#/components/schemas/_types.ErrorCause'
        shard:
          type: number
        status:
          type: string
        primary:
          type: boolean
      required:
      - reason
    searchable_snapshots.cache_stats.Shared:
      type: object
      properties:
        reads:
          type: number
        bytes_read_in_bytes:
          allOf:
          - $ref: '#/components/schemas/_types.ByteSize'
        writes:
          type: number
        bytes_written_in_bytes:
          allOf:
          - $ref: '#/components/schemas/_types.ByteSize'
        evictions:
          type: number
        num_regions:
          type: number
        size_in_bytes:
          allOf:
          - $ref: '#/components/schemas/_types.ByteSize'
        region_size_in_bytes:
          allOf:
          - $ref: '#/components/schemas/_types.ByteSize'
      required:
      - reads
      - bytes_read_in_bytes
      - writes
      - bytes_written_in_bytes
      - evictions
      - num_regions
      - size_in_bytes
      - region_size_in_bytes
    searchable_snapshots._types.StatsLevel:
      type: string
      enum:
      - cluster
      - indices
      - shards
    _types.ByteSize:
      oneOf:
      - type: number
      - type: string
    _types.Name:
      type: string
    _types.NodeId:
      type: string
    _types.ExpandWildcard:
      type: string
      enum:
      - all
      - open
      - closed
      - hidden
      - none
    _types.IndexName:
      type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: "Elasticsearch APIs support key-based authentication.\nYou must create an API key and use the encoded value in the request header.\nFor example:\n\n```\ncurl -X GET \"${ES_URL}/_cat/indices?v=true\" \\\n  -H \"Authorization: ApiKey ${API_KEY}\"\n```\n\nTo get API keys, use the `/_security/api_key` APIs."
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API.

        For examples, refer to [Token-based authentication services](https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/token-based-authentication-services)'
x-tagGroups:
- name: AI & Machine Learning
  tags:
  - analytics
  - graph
  - inference
  - ml
  - ml anomaly
  - ml data frame
  - ml trained model
  - query_rules
  - text_structure
- name: Cluster Management
  tags:
  - ccr
  - cluster
  - connector
  - data stream
  - ilm
  - indices
  - rollup
  - script
  - search_application
  - searchable_snapshots
  - slm
  - snapshot
- name: Data Processing
  tags:
  - enrich
  - fleet
  - ingest
  - logstash
  - synonyms
  - transform
- name: Information & Monitoring
  tags:
  - cat
  - features
  - health_report
  - info
  - license
  - migration
  - tasks
  - watcher
  - xpack
- name: Search & Document APIs
  tags:
  - document
  - eql
  - esql
  - search
  - sql
- name: Security
  tags:
  - security