Update Site Mode

URL:
https://<root>/mode/update
Methods:
POST
Required Capability:
Access allowed only with the 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.

Request parameters

ParameterDetails

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.

Values: true | false

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the update operation:

1
2
3
4
5
6
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=pjson

JSON Response example

1
{"status": "success"}

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close