- URL:https://<mode-url>/update(POST only)
- 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.
Note:
The default options when enabling READ_ONLY mode can be changed by configuring them in the serverProperties resource. You can choose not to copy configurations locally and not to restart services. See the serverProperties resource for the required format for changing these options.
Request parameters
| Parameter | Details |
|---|---|
| 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:
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=jsonJSON Response example
{"status": "success"}