Skip To Content
ArcGIS Developers
Dashboard

Update (Mode)

Description

This operation enables read-only mode for an ArcGIS Enterprise on Kubernetes deployment. It is recommended that read-only mode is enabled when upgrading a deployment to ensure that no data loss or downtime occurs. When read-only mode is enabled, users will be able to interact with preexisting content, though attempts to create or modify any data (creating a new user, updating the properties of a feature service) will be blocked.

Request parameters

ParameterDetails
isReadOnly

(Required)

A boolean that specifies whether the organization 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

message

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.

message=ArcGIS Enterprise is currently in read-only mode. Contact your administrator for further assistance.
f

The response format. The default format is html.

Values: html | json | pjson

Example usage

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

POST /context/admin/mode/update HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

isReadOnly=true&message=ArcGIS Enterprise is currently in read-only mode. Contact your administrator for further assistance&f=json&token=HRozb6bnTL6gfA-SJO-IxhfLgJrioK1KJdMLWmCE5HjHWz9U3fOiFv3-HkgPZqsLljTkk2WDENGt5fjho5s39e_mZL5At60UvJPoNnC5O2sv2HTlumG7TsYfbtnokpWmS6-lf8XoQpSKusZwmxIkEMP-yE0Wxrj8o9sWKi29J-pxzkoCDhoUfdLt6NnBWxhESpegh8BzNcEruqxuDQD-JRmaTsbRDaBHTQTePMzQePhXl7KcEG9Cfkw2sa7P1W1e

JSON Response example

{
  "status": "success",
  "messages": []
}