1. REST API for Enterprise Communications Broker Release 3.3.0
  2. Tasks
  3. admin

Execute HA switchover

post

/rest/{version}/admin/switchover

Executes an HA switchover to switch from the active server to the standby server.

For more information on high availability, see High Availability in the ACLI Configuration Guide.

Request

Path Parameters
  • REST API version string.
    Available values: v1.1
Header Parameters
  • The value in the Authorization header must be the string "Bearer {access token}", where {access token} is a valid, unexpired token received in response to a prior /rest/{version}/auth/token request.
Back to Top

Response

204 Response

HA switchover request received. The switchover operation can take up to five seconds after the ECB sends a response to the client.

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.

401 Response

Unauthorized - Request lacks valid authentication credentials.

403 Response

This request requires the client credentials to have administrator privileges.

404 Response

Unsupported versionId in URI.
Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to execute an HA switchover by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X POST \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://10.0.0.2/rest/v1.1/admin/switchover"

Example of Accessing the API with Python

The following example shows how to execute an HA switchover by submitting a POST request on the REST resource using Python. This example assumes you have a valid token stored in the token variable. For an example of authenticating with Python, see Authenticate. 

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://10.0.0.2/rest/v1.1/admin/switchover"
resp = requests.post(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Date: Fri, 11 Jan 2019 16:24:18 GMT
Cache-Control: no-cache
Content-Length: 0
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Fri, 11 Jan 2019 16:24:18 GMT
X-Appweb-Seq: 3

Example of the Response Body

This endpoint does not return a response body.

Back to Top