Mode

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

Description

The mode resource returns the current mode for the server site. ArcGIS Server allows you to control changes to your site. You can set the site mode to READ_ONLY to disallow the publishing of new services and block most administrative operations. Your existing services will continue to function as they did previously. Note that certain administrative operations such as adding and removing machines from a site are still available in READ_ONLY mode.

The default site mode is EDITABLE, which means all administrative and publishing operations are allowed on the site. By default, all services will be restarted when the site mode is set to READ_ONLY. Additionally, setting the site mode to READ_ONLY will copy the site configuration files to a local repository on each machine in the site. This default behaviour will enable the site to operate in a degraded capacity when there are connection failures to the configuration store.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Response properties

PropertyDetails

siteMode

The current mode of the site. Response can be READ_ONLY or EDITABLE.

copyConfigLocal

Whether the site configuration files will be copied to the local repository upon switching to READ_ONLY. Response can be true or false.

lastModified

Time stamp indicating the last time the site mode was modified.

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/admin/mode?f=pjson

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
{
  "siteMode": "READ_ONLY",
  "copyConfigLocal": true,
  "lastModified": <timestamp>
}

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