kibana/docs/api/upgrade-assistant/status.asciidoc
Kaarina Tungseth 3b833f3d5b
[DOCS] Updates Upgrade Assistant API status (#125410)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-02-14 11:50:48 -06:00

38 lines
1,004 B
Text

[[upgrade-assistant-api-status]]
=== Upgrade readiness status API
++++
<titleabbrev>Upgrade readiness status</titleabbrev>
++++
experimental["The underlying Upgrade Assistant concepts are stable, but the APIs for managing Upgrade Assistant are experimental."]
Check the status of your cluster.
[[upgrade-assistant-api-status-request]]
==== Request
`GET <kibana host>:<port>/api/upgrade_assistant/status`
[[upgrade-assistant-api-status-response-codes]]
==== Response codes
`200`::
Indicates a successful call.
[[upgrade-assistant-api-status-example]]
==== Example
The API returns the following:
[source,sh]
--------------------------------------------------
{
"readyForUpgrade": false,
"cluster": [
{
"message": "Cluster deprecated issue",
"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."
}
]
}
--------------------------------------------------