Update Mode

URL:
https://<mode-url>/update
Methods:
POST
Required Capability:
Administrator
Version Introduced:
10.8

Description

The update operation is used to move between the two types of site modes. Switching to READ_ONLY mode will restart all your services as the default behavior. Moving to EDITABLE mode will not restart services.

Request parameters

ParameterDetails

siteMode

(Required)

The mode to which you will set your site.

Values: READ_ONLY | EDITABLE

f

The response format. The default response format is html .

Values: html | json | pjson

Example usage

Below is a sample request URL for the root resource:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /webadaptor/admin/mode/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

siteMode=READ_ONLY&f=json

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.