15 Maintenance Mode

15.1 Get

GET https://<HOST>:<PORT>/api/maintenanceMode/get?version=0

Returns whether the maintenance mode is active or not

Required Permissions

  • API

Response Body Structure

The response body is structured as MaintenanceMode JSON object. A description for its fields is at section 30.20.1. For the JSON schema refer to section 30.20.2.

Example

GET http://127.0.0.1:8888/api/maintenanceMode/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{"modeActive": true}

15.2 Set

PUT https://<HOST>:<PORT>/api/maintenanceMode/set?version=0

Enables or disables the maintenance mode.

Required Permissions

  • API

  • Administration

Request Body Structure

The request body is structured as MaintenanceMode JSON object. A description for its fields is at section 30.20.1. For the JSON schema refer to section 30.20.2.

Response Body Structure

The response body is structured as MaintenanceMode JSON object. A description for its fields is at section 30.20.1. For the JSON schema refer to section 30.20.2.

Example

PUT http://127.0.0.1:8888/api/maintenanceMode/set?version=0
HTTP Request Body
{"modeActive": false}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{"modeActive": false}