kibana/docs/api/upgrade-assistant/status.asciidoc
Kaarina Tungseth fda3196611
[DOCS] Updates API requests and examples (#60695)
* [DOCS] Updates API requests and examples

* Review comments
2020-03-20 16:33:20 -05:00

53 lines
1.2 KiB
Plaintext

[[upgrade-assistant-api-status]]
=== Upgrade readiness status API
++++
<titleabbrev>Upgrade readiness status</titleabbrev>
++++
experimental[] Check the status of your cluster.
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": "...",
"level": "warning",
"url": "https://docs.elastic.co/..."
}
],
"indices": [
{
"message": "Index was created before 6.0",
"details": "...",
"index": "myIndex",
"level": "critical",
"reindex": true, <1>
"url": "https://docs.elastic.co/..."
}
]
}
--------------------------------------------------
<1> To fix indices with the `reindex` attribute, set to `true` using the <<start-resume-reindex, Start or resume reindex API>>.