Elastic Info API

openapi: 3.2.0
info:
  title: Elasticsearch Info 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: Info
  description: Get basic information about the cluster.
  x-displayName: Info
paths:
  /:
    get:
      tags:
      - Info
      summary: Get cluster info
      description: 'Get basic build, version, and cluster information.

        ::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored.'
      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: The running version of Elasticsearch.
                    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. This API is retained for backward compatibility only. Some fields, such as the version number, return static values and should be ignored.
                  value: "{\n  \"name\": \"serverless\",\n  \"cluster_name\": \"my_test_serverless_cluster\",\n  \"cluster_uuid\": \"8xx0pi24Squnf4PFDOAtwg\",\n  \"version\": {\n    \"number\": \"8.11.0\",\n    \"build_flavor\": \"serverless\",\n    \"build_type\": \"docker\",\n    \"build_hash\": 0,\n    \"build_date\": \"2023-10-31T00:00:00.000Z\",\n    \"build_snapshot\": false,\n    \"lucene_version\": \"9.7.0\",\n    \"minimum_wire_compatibility_version\": \"8.11.0\",\n    \"minimum_index_compatibility_version\": \"8.11.0\"\n  },\n  \"tagline\": \"You Know, for Search\"\n}"
      x-state: Generally available
      x-variations:
      - "<div>\n              <span class=\"operation-verb get\">GET</span>\n              <span class=\"operation-path\">/</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `monitor`

        '
      x-api: info
      x-category: info
      x-codeSamples:
      - lang: Console
        source: 'GET /

          '
      - lang: Python
        source: resp = client.info()
      - lang: JavaScript
        source: const response = await client.info();
      - lang: Ruby
        source: response = client.info
      - lang: PHP
        source: $resp = $client->info();
      - lang: curl
        source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/"'
      - lang: Java
        source: 'client.info();

          '
      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.UnitMillis:
      description: Time unit for milliseconds
      type: number
    _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.Uuid:
      type: string
    _types.VersionString:
      type: string
    _types.Name:
      type: string
    _types.EpochTimeUnitMillis:
      allOf:
      - $ref: '#/components/schemas/_types.UnitMillis'
  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