Endpoint: /server/ha/upgrade

Note: Available as of EFT 8.1.0

The GET request returns node HA upgrade state. Additionally, the POST request changes the entire HA cluster state to the upgrade or normal state.

Method & URL

GET https://[server URL]:[port]/admin/v2/server/ ha/upgrade

GET Body Sample

Copy 
### GET server upgrade state ###
GET https://{{host}}/admin/v2/server/ha/upgrade HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}
###

GET Response Body Sample

Copy 
{ "data": "notInUpgrade" }

GET PowerShell Sample

Copy 
#########
#Get Server Upgrade State
Write-Output "Get Server Upgrade State: "
Write-Output "-----"
$upgradeState = Invoke-RestMethod -Uri "$baseURL/v2/server/ha/upgrade" -Method 'GET' -Headers $authHeader
Write-Output $upgradeState | ConvertTo-Json -Depth 10  

Method & URL

POST https://[server URL]:[port]/admin/v2/server/ ha/upgrade

POST Body Sample

Copy 
### "Normal" state -> "Upgrade" state ###
POST https://{{host}}/admin/v2/server/ha/upgrade HTTP/1.1
Authorization: EFTAdminAuthToken {{AuthToken}}

{
    "data":
    {
        "action":"begin"
    }
}
###

POST PowerShell Sample

Copy 
###
#POST Server Upgrade State to “begin”
Write-Output "Server Upgrade State POST"
Write-Output "-----"
$update = 
'{
    "data":
    {
        "action":"begin"
    }
}'    
$patchReturn = Invoke-RestMethod -Uri "$baseURL/v2/server/ha/upgrade" -Method 'POST' -Headers 
$authHeader -Body $update