Available since v. 2.35.0

Get current status

Available ONLY for Confluence System Administrators

Method type: GET

URL: {CONFLUENCE_URL}/rest/extender/1.0/maintenance/status

Response format: JSON

Example response:

{
    "readOnlyMode": true,
    "bannerMessageOn": true,
    "bannerMessageText": "RO Enabled - please wait"
}

{
    "readOnlyMode": false,
    "bannerMessageOn": false,
    "bannerMessageText": "This site is read-only while we complete some maintenance. You can't create or edit pages right now."
}

{
    "readOnlyMode": false,
    "bannerMessageOn": true,
    "bannerMessageText": "RO Enabled - please wait"
}

Change status

Available ONLY for Confluence System Administrators

Method type: POST

URL: {CONFLUENCE_URL}/rest/extender/1.0/maintenance/set

Request format: JSON

Example request:

{
    "readOnlyMode": true,
    "bannerMessageText": "Example text"
}

{
    "readOnlyMode": false,
    "bannerMessageOn": true,
    "bannerMessageText": "Example text"
}

{
    "bannerMessageOn": true,
    "bannerMessageText": "Example text"
}

Response format: JSON

Example response:

{
    "message": 
          "Read-only mode set to 'ON', the banner set to 'ON' and its message is set to 'Example text 222222'",
    "status": "done"
}

{
    "message": 
          "Read-only mode set to 'OFF', the banner set to 'ON' and its message is set to 'Example text 222222'",
    "status": "done"
}

Extender for Confluence

REST API - Maintenance (Read-only mode)

Analytics

Get current status

Change status

Related content