- URL:https://<mode-url>/update
- Required Capability:Default administrator role
- Version Introduced:10.8
Description
This operation enables read-only mode for your ArcGIS Enterprise deployment. It is recommended that read-only mode is enabled whenever you are upgrading your Enterprise deployment to ensure that no data loss or downtime occurs. When read-only mode is enabled, users will still be able to interact with your preexisting content. However, attempts to create or modify any data, such as creating a new user or updating the properties of a feature service, will be blocked. For more information on read-only mode, see Read-only mode in ArcGIS Enterprise.
Request parameters
| Parameter | Details |
|---|---|
| isReadOnly | A boolean that specifies whether the Enterprise portal is in read-only mode. Read-only mode will block requests to modify or create any data, including content, users, groups, or site settings. The default value is false. Values: true | false |
| description | Sets a custom message to be displayed whenever an attempt to modify or update content or site settings is made through the API. If no message is entered, a default response is used. Example |
| f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
Below is a sample POST request for update that demonstrates how to enable read-only mode:
POST /webadaptor/portaladmin/mode/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
isReadOnly=true&description=ArcGIS Enterprise is currently in read-only mode. Contact your administrator for further assistance&f=jsonJSON Response example
{
"status": "success",
"messages": []
}