Skip to main content

Enabled/disabled maintenance mode

POST <your-unleash-url>/api/admin/maintenance

Authorization

name: Authorizationtype: apiKeyin: header

Lets administrators put Unleash into a mostly read-only mode. While Unleash is in maintenance mode, users can not change any configuration settings

Request

Body

required

toggleMaintenanceSchema

  • enabled boolean required

    true if you want to activate maintenance mode, false if you want to deactivate it.

Responses

This response has no body.

Authorization

name: Authorizationtype: apiKeyin: header

Request

Base URL
<your-unleash-url>
apiKey
Body required
{
"enabled": true
}
curl / cURL
curl -L -X POST '<your-unleash-url>/api/admin/maintenance' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"enabled": true
}'