Brekeke UC Wiki

status

(Available in Brekeke UC version 1.7.3.1 or later)

Gets the Brekeke UC status (active/standby).
To perform this operation, you must specify the allowed IP addresses using a regular expression. If you want to use a password, set the password in Advanced Options. Changes in Advanced Options take effect immediately. If you do not want to use a password, there is no need to set a password in Advanced Options.

 

Advanced Options Properties:
webif.v1p.db.hosts.allow=<IP address>
webif.v1p.db.password=<password>

 

Operation:
v1p/db/status

 

Operation parameters:
number Parameters Note
1 password Operation execution password (if required)

 

Response Code:
Response Code Note
200 OK. Brekeke UC status acquisition successful
400 Bad Request. Parameter error or password mismatch
403 Forbidden. No access (IP restrictions, etc.)
503 Service Unavailable. Unable to run for some reason (during startup, etc.)

 

Response data:
{ "standby":<Status> }

[Status] true: Standby, false: Active

 

Example 1: No password
curl -X POST "https://<uc-url>/webif/v1p/db/status"

 

Example 2: With a password
curl -X POST --header "Content-Type: application/json" --data "{\"password\":\"123abc@%&\"}" "https://<uc-url>/webif/v1p/db/status"

 

 

Yes No
Suggest Edit