Reference Guide

SupportAssist Enterprise
44 REST API Guide SupportAssist Enterprise
2.7 Maintenance mode
The maintenance mode feature suspends the alert processing and automatic case creation capability of
SupportAssist Enterprise, thereby preventing the creation of support cases during an alert storm or a planned
maintenance activity. If an alert storm is received from a monitored device, SupportAssist Enterprise automatically
places the device in maintenance mode. You can also manually enable the maintenance mode functionality
before a planned maintenance activity to temporarily suspend the automatic case creation capability.
2.7.1 Device maintenance mode
The following resource URI is used to place the device in and out of maintenance mode:
https://<BASE_URI>/SupportAssist/api/v1/Device/MaintenanceMode/<action>
The possible values for <action> in the URI are “enable” or “disable”
Method: POST
Headers:
Content-Type: application/json
Authorization: Bearer <Authentication_Token>
The following is an example to enable maintenance mode for two devices:
https://<BASE_URI>/SupportAssist/api/v1/Device/MaintenanceMode/enable
Request body:
[
{"id": "<Device_id>"},
{"id": "<Device_id>"}
]
Response format (success response code 204): none
The following is an example to disable maintenance mode for two devices:
https://<BASE_URI>/SupportAssist/api/v1/Device/MaintenanceMode/disable
Request body:
[
{"id": "<Device_id>"},
{"id": "<Device_id>"}
]
Response format (success response code 204): none
2.7.2 Site maintenance mode
The following resource URI is used to place SupportAssist Enterprise in maintenance mode:
https://<BASE_URI>/SupportAssist/api/v1/Global/MaintenanceMode/<action>
The possible values for action in the URI are “enable” or “disable”
Method: POST