Get maintenance mode status
GET<your-unleash-url>/api/admin/maintenance
Tells you whether maintenance mode is enabled or disabled
Responses
- 200
- 401
- 403
maintenanceSchema
- application/json
- Schema
- Example (auto)
Schema
enabled booleanrequired
Whether maintenance mode is enabled or not.
Example:
true
{
"enabled": true
}
Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`.
- application/json
- Schema
- Example (auto)
Schema
id string
The ID of the error instance
Example:
9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example:
AuthenticationRequired
message string
A description of what went wrong.
Example:
You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "AuthenticationRequired",
"message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}
The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- application/json
- Schema
- Example (auto)
Schema
id string
The ID of the error instance
Example:
9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example:
NoAccessError
message string
A description of what went wrong.
Example:
You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}
Authorization: Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L '<your-unleash-url>/api/admin/maintenance' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
ResponseClear