[Feedback]: Clarify upgrade assistant API #3341
Description
Description
Users are confused about which service the upgrade assistant API applies to. The current Kibana API documentation lists the endpoint /api/upgrade_assistant/status, but since the Upgrade Assistant page is one of the last pages, it is difficult to easily understand this is a Kibana API.
Since this page does not explicitly state that it is a Kibana API and must be called against the Kibana endpoint, not Elasticsearch, this has led to user errors when trying to access the API from Elasticsearch (for example, using https://localhost:9200/api/upgrade_assistant/status) and receiving “no handler found” responses.
Example user feedback
“From curl I need to go to upgrade assistant API, from documentation it is /api/upgrade_assistant/status.
My command:
curl -XGET -k -uelastic:"$(bin/elasticsearch-keystore show bootstrap.password)" 'https://localhost:9200/api/upgrade_assistant/status'
Response: {"error":"no handler found for uri [/api/upgrade_assistant/status] and method [GET]"}
Expected outcome
Users should understand:
- The Upgrade Assistant API is a Kibana API.
- It should be accessed via the Kibana URL (for example: https://your-kibana:5601/api/upgrade_assistant/status).
- Authentication requirements and example commands should reflect Kibana, not Elasticsearch.
Proposed solution
Update the API documentation to:
- Clearly state at the top that this is a Kibana REST API.
- Include a note or warning block explaining that it does not work on Elasticsearch endpoints.
- Update example curl commands to use the Kibana port (5601) and format for authentication.
- Optionally, add a short explanation of the relationship between Kibana APIs and Elasticsearch APIs for context.