- URL:https://<portaladmin-url>/mode
- Operations:Update Mode
- Required Capability:Default administrator role | All authorized privileges
- Version Introduced:10.8
Description
This resource returns whether your ArcGIS Enterprise deployment has been set to read-only mode. When enabled, the Enterprise portal, connected hosting and federated servers, and ArcGIS Data Stores are all set into read-only mode. During this time, most POST requests and administrative functions are blocked. Users within your organization will still be able to view and access your content; however, attempts to create, modify or delete content or site properties will be blocked. To learn more about read-only mode, see Read-only mode in ArcGIS Enterprise.
Note:
The Update operation will only affect servers that had not previously been set to read-only mode. When Update is used to enable read-only mode, servers that were originally set to read-only mode will not be affected. When Update is used to disable read-only mode, those same servers will be unaffected and will remain in read-only mode.
Request parameters
| Parameter | Details |
|---|---|
| f | The response format. The default response format is html. Values: html | json | pjson |
Example usage
Below is a sample request URL for the mode resource:
https://machine.domain.com/webadaptor/portaladmin/mode?f=jsonJSON Response example
Read-only mode disabled:
{"isReadOnly": false}Read-only mode enabled:
{
"isReadOnly": true,
"message": "ArcGIS Enterprise is currently in read-only mode. Contact your administrator for further assistance.",
"servers": ["k74NUJZhhtol35fv"]
}