- URL:https://<mode-url>/update(POST only)
- Required Capability:Default administrator role
- Version Introduced:10.4
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 |
| runAsync (Optional) | Determines whether this operation must run asynchronously. Values: true | false |
| allowEditingViaServices (Optional) | Specifies whether edits to feature services are allowed while a server is in read-only mode. The default value is true. When set to false, edits to feature services will not be allowed and operations that can be used to make such edits, such as Add to Definition and Apply Edits, will be unusable. Note:This parameter will be automatically set to false if the Portal Admin Update Mode operation has been used to place your Enterprise deployment in read-only mode. You will be able to override this default false value for individual federated servers afterward if necessary. Values: true | false |
| f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
Below is a sample POST request for update:
POST /webadaptor/admin/mode/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
siteMode=READ_ONLY&runAsync=true&allowEditingViaServices=false&f=jsonJSON Response example
{"status": "success"}