Content Management API > Maintenance mode

Activate maintenance mode: this means that the primary environment will be read-only

Query parameters

force boolean

Force the activation, even if there are collaborators editing some records.

Returns

Returns a resource object of type maintenance_mode.

Examples

1
PUT https://site-api.datocms.com/maintenance-mode/activate HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3

1
curl -g 'https://site-api.datocms.com/maintenance-mode/activate' \
2
  -X PUT \
3
  -H "Authorization: Bearer YOUR-API-TOKEN" \
4
  -H "Accept: application/json" \
5
  -H "X-Api-Version: 3"

1
await fetch("https://site-api.datocms.com/maintenance-mode/activate", {
2
  method: "PUT",
3
  headers: {
4
    Authorization: "Bearer YOUR-API-TOKEN",
5
    Accept: "application/json",
6
    "X-Api-Version": "3",
7
  },
8
});

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Cache-Control: cache-control: max-age=0, private, must-revalidate
4
X-RateLimit-Limit: 30
5
X-RateLimit-Remaining: 28
6

7
{
8
  "data": {
9
    "type": "maintenance_mode",
10
    "id": "maintenance_mode",
11
    "attributes": {
12
      "active": false
13
    }
14
  }
15
}

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.