Delivers an ActiveBackend document showing the name of the backend which is actually considered to be active for M&C redundancy switching. Also permits to change this using a PUT call.
Supported HTTP methods: GET, PUT, HEAD, OPTIONS
GET /api/v1/activebackend
Returns an ActiveBackend document showing the name of the backend which is actually considered to be active for M&C redundancy switching.
Parameters: none
Expected Payload: none.
Replied Payload: Returns an ActiveBackend document showing the name of the backend which is actually considered to be active for M&C redundancy switching.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns the expected document |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |
PUT /api/v1/activebackend
Sets the name of the of the backend which is actually considered to be active for M&C redundancy switching.
Parameters: none
Expected Payload: An ActiveBackend document containing the name of the backend which shall be considered to be active for M&C redundancy switching.
Replied Payload: Returns an ActiveBackend document showing the name of the backend which is actually considered to be active for M&C redundancy switching.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, the name of the active backend has been updated. Returns the expected document |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |
| 500 | DB is not writable. In this case an ApiError document is returned,describing details of the error. |