Mode

URL:
https://<root>/mode
Methods:
GET
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.8

Description

The mode 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.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access the mode resource:

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/portaladmin/mode?f=pjson

JSON Response example

Read-only mode disabled:

Use dark colors for code blocksCopy
1
{"isReadOnly": false}

Read-only mode enabled:

Use dark colors for code blocksCopy
1
2
3
4
5
{
  "isReadOnly": true,
  "message": "ArcGIS Enterprise is currently in read-only mode. Contact your administrator for further assistance.",
  "servers": ["k74NUJZhhtol35fv"]
}

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