Enable or disable maintenance mode

**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).

POST/setup/api/maintenance

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Body Params

required

application/x-www-form-urlencodedobject

maintenance string

required

A JSON string with the attributes `enabled` and `when`. The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled. The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).

Responses

application/json maintenance-status object

Response

connection_services array[object]

optional

items object

name string

required

number integer

required

scheduled_time string

optional

status string

optional

Response Example: 200 application/json

{
  "connection_services": [
    {
      "name": "git operations",
      "number": 0
    },
    {
      "name": "mysql queries",
      "number": 233
    },
    {
      "name": "resque jobs",
      "number": 54
    }
  ],
  "scheduled_time": "Tuesday, January 22 at 15:34 -0800",
  "status": "scheduled"
}

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

Request Sample: Shell / cURL

curl --request POST \
  --url {protocol}://{hostname}/api/v3/setup/api/maintenance \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data '{
  "maintenance": "{\"enabled\":true, \"when\":\"now\"}"
}'