Set Edge maintenance mode

Request:

Method:

PUT

URI Path(s):

/api/v1/node/maintenance-mode
/api/v1/transport-nodes/<transport-node-id>/node/maintenance-mode
/api/v1/cluster/<cluster-node-id>/node/maintenance-mode

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

MaintenanceModePropertiesRequest+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
maintenance_mode	current maintenance mode	boolean
notify_mpa	send notification to MPA	boolean	Default: "True"

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

MaintenanceModePropertiesReply+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
maintenance_mode	current maintenance mode	string	Readonly Enum: enabled, disabled Default: "disabled"

Required Permissions:

crud

Feature:

system_administration

Additional Errors:

301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable