HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. maintenanceMode

Configure appliance maintenance mode

post
http://127.0.0.1:8080/maintenanceMode

Add or remove appliances from maintenance mode. Maintenance mode allows pausing orchestration (configuration changes queued) and suppressing alarms (alerts disabled) for specified appliances.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Maintenance mode configuration specifying action and target appliances.

Request body for adding or removing appliances from maintenance mode.

string
enum
required

Action to perform on the specified appliances. Use 'add' to enter maintenance mode or 'remove' to exit.

Allowed:
nePks
array of objects
required

List of appliance identifiers (nePks).

nePks*
data
object
required

Specifies which appliances to add/remove from pauseOrchestration and suppressAlarm lists. Only entries also present in nePks are processed.

Responses
204

Maintenance mode configuration updated successfully. No content returned.

401

Unauthorized. Requires READ_WRITE role permission.

Updated about 11 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 11 hours ago

Did this page help you?