Elastic Stack (ELK Stack) Upgrade API

openapi: 3.2.0
info:
  contact:
    name: Kibana Team
  description: The Kibana REST APIs enable you to manage resources such as connectors, data views, and saved objects.
  title: Kibana Upgrade API
  version: ''
  x-doc-license:
    name: Attribution-NonCommercial-NoDerivatives 4.0 International
    url: https://creativecommons.org/licenses/by-nc-nd/4.0/
  x-feedbackLink:
    label: Feedback
    url: https://github.com/elastic/docs-content/issues/new?assignees=&labels=feedback%2Ccommunity&projects=&template=api-feedback.yaml&title=%5BFeedback%5D%3A+
servers:
- url: https://{kibana_url}
  variables:
    kibana_url:
      default: localhost:5601
security:
- apiKeyAuth: []
- basicAuth: []
tags:
- description: 'The Kibana Upgrade Assistant API helps you prepare for the next major Elasticsearch release.

    > warn

    > This is a Kibana REST API (not an Elasticsearch API) and requests must target your Kibana URL:

    > * Self-managed URL pattern: `https://localhost:5601`

    > * Elastic Cloud URL pattern: `https://your-deployment.kb.us-east-1.aws.elastic.cloud:9243`'
  name: Upgrade
  x-displayName: Upgrade assistant
paths:
  /api/upgrade_assistant/status:
    get:
      description: Check the status of your cluster.
      operationId: get-upgrade-status
      responses:
        '200':
          content:
            application/json:
              examples:
                getUpgradeStatusResponseExample1:
                  value: "{\n  \"readyForUpgrade\": false,\n  \"cluster\": [\n    {\n      \"message\": \"Cluster deprecated issue\",\n      \"details\":\"You have 2 system indices that must be migrated and 5 Elasticsearch deprecation issues and 0 Kibana deprecation issues that must be resolved before upgrading.\"\n    }\n  ]\n}"
          description: Indicates a successful call.
      summary: Get the upgrade readiness status
      tags:
      - Upgrade
      x-state: Technical Preview
      x-metaTags:
      - content: Kibana
        name: product_name
components:
  securitySchemes:
    apiKeyAuth:
      description: 'These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: `Authorization: ApiKey base64AccessApiKey`

        '
      in: header
      name: Authorization
      type: apiKey
    basicAuth:
      scheme: basic
      type: http
x-topics:
- title: Kibana spaces
  content: "Spaces enable you to organize your dashboards and other saved objects into meaningful categories.\nYou can use the default space or create your own spaces.\n\nTo run APIs in non-default spaces, you must add `s/{space_id}/` to the path.\nFor example:\n\n```bash\ncurl -X GET \"http://${KIBANA_URL}/s/marketing/api/data_views\" \\\n  -H \"Authorization: ApiKey ${API_KEY}\"\n```\n\nIf you use the Kibana console to send API requests, it automatically adds the appropriate space identifier.\n\nTo learn more, check out [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces).\n"