Elastic Stack (ELK Stack) Info API

openapi: 3.2.0
info:
  title: Elasticsearch Request & Response Specification Info API
  license:
    name: Apache 2.0
    url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE
  version: ''
tags:
- name: info
paths:
  /:
    get:
      tags:
      - info
      summary: Get cluster info
      description: 'Get basic build, version, and cluster information.

        ::: In Serverless, `version.number` always reports the next target Elasticsearch release version at the time of the request. Serverless does not track to a traditional release versioning model; it is continuously updated. The version number is provided to maintain compatibility with existing clients, but it is not meaningful for assessing feature availability. Clients should detect a Serverless environment by checking for `build_flavor: serverless`.


        ## Required authorization


        * Cluster privileges: `monitor`

        '
      externalDocs:
        description: Learn about Serverless differences
        url: https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings
        x-previousVersionUrl: https://www.elastic.co/guide/en/elasticsearch/reference/8.19/rest-api-root.html
      operationId: info
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  cluster_name:
                    description: The responding cluster's name.
                    allOf:
                    - $ref: '#/components/schemas/_types.Name'
                  cluster_uuid:
                    allOf:
                    - $ref: '#/components/schemas/_types.Uuid'
                  name:
                    description: The responding node's name.
                    allOf:
                    - $ref: '#/components/schemas/_types.Name'
                  tagline:
                    type: string
                  version:
                    description: 'Version information for the Elasticsearch cluster. In Serverless, `version.number` always reports the next target Elasticsearch release version at the time of the request, not an actual deployed version. The version number is provided to maintain client compatibility but is not meaningful for assessing feature availability. Use `build_flavor: serverless` to detect a Serverless environment.'
                    allOf:
                    - $ref: '#/components/schemas/_types.ElasticsearchVersionInfo'
                required:
                - cluster_name
                - cluster_uuid
                - name
                - tagline
                - version
              examples:
                RootNodeInfoResponseExample1:
                  summary: Stack response
                  description: A successful response from `GET /`.
                  value: "{\n  \"name\": \"instance-0000000000\",\n  \"cluster_name\": \"my_test_cluster\",\n  \"cluster_uuid\": \"zk-HjQtYQGyL3NFSSu7InA\",\n  \"version\": {\n    \"number\": \"9.1.0\",\n    \"build_flavor\": \"default\",\n    \"build_type\": \"docker\",\n    \"build_hash\": 0,\n    \"build_date\": \"2025-07-09T22:10:13.578Z\",\n    \"build_snapshot\": false,\n    \"lucene_version\": \"10.2.2\",\n    \"minimum_wire_compatibility_version\": \"8.19.0\",\n    \"minimum_index_compatibility_version\": \"8.0.0\"\n  },\n  \"tagline\": \"You Know, for Search\"\n}"
                RootNodeInfoResponseExample2:
                  summary: Serverless response
                  description: A successful response from `GET /` on Serverless. The `version.number` shown here is illustrative; Serverless always reports the next target Elasticsearch release version at the time of the request, so the actual value will differ from this example.
                  value: "{\n  \"name\": \"serverless\",\n  \"cluster_name\": \"my_test_serverless_cluster\",\n  \"cluster_uuid\": \"8xx0pi24Squnf4PFDOAtwg\",\n  \"version\": {\n    \"number\": \"9.4.0\",\n    \"build_flavor\": \"serverless\",\n    \"build_type\": \"docker\",\n    \"build_hash\": \"6b73650b7c4192d4a7ef1d75a368dad7d28f1ae0\",\n    \"build_date\": \"2026-03-31T12:25:05.021Z\",\n    \"build_snapshot\": false,\n    \"lucene_version\": \"10.4.0\",\n    \"minimum_wire_compatibility_version\": \"9.4.0\",\n    \"minimum_index_compatibility_version\": \"9.4.0\"\n  },\n  \"tagline\": \"You Know, for Search\"\n}"
      x-state: Generally available
      x-metaTags:
      - content: Elasticsearch
        name: product_name
components:
  schemas:
    _types.DateTime:
      description: '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 accepts both as input, but will generally output a string

        representation.'
      oneOf:
      - type: string
      - $ref: '#/components/schemas/_types.EpochTimeUnitMillis'
    _types.ElasticsearchVersionInfo:
      type: object
      properties:
        build_date:
          description: The Elasticsearch Git commit's date.
          allOf:
          - $ref: '#/components/schemas/_types.DateTime'
        build_flavor:
          description: The build flavor. For example, `default`.
          type: string
        build_hash:
          description: The Elasticsearch Git commit's SHA hash.
          type: string
        build_snapshot:
          description: Indicates whether the Elasticsearch build was a snapshot.
          type: boolean
        build_type:
          description: 'The build type that corresponds to how Elasticsearch was installed.

            For example, `docker`, `rpm`, or `tar`.'
          type: string
        lucene_version:
          description: The version number of Elasticsearch's underlying Lucene software.
          allOf:
          - $ref: '#/components/schemas/_types.VersionString'
        minimum_index_compatibility_version:
          description: The minimum index version with which the responding node can read from disk.
          allOf:
          - $ref: '#/components/schemas/_types.VersionString'
        minimum_wire_compatibility_version:
          description: 'The minimum node version with which the responding node can communicate.

            Also the minimum version from which you can perform a rolling upgrade.'
          allOf:
          - $ref: '#/components/schemas/_types.VersionString'
        number:
          description: "The Elasticsearch version number.\n\n::: IMPORTANT: For Serverless deployments, this static value is always `8.11.0` and is used solely for backward compatibility with legacy clients.\n Serverless environments are versionless and automatically upgraded, so this value can be safely ignored."
          type: string
      required:
      - build_date
      - build_flavor
      - build_hash
      - build_snapshot
      - build_type
      - lucene_version
      - minimum_index_compatibility_version
      - minimum_wire_compatibility_version
      - number
    _types.EpochTimeUnitMillis:
      allOf:
      - $ref: '#/components/schemas/_types.UnitMillis'
    _types.Name:
      type: string
    _types.VersionString:
      type: string
    _types.UnitMillis:
      description: Time unit for milliseconds
      type: number
    _types.Uuid:
      type: string