Update Mode

URL:
https://<root>/mode/update
Methods:
POST
Required Capability:
Access allowed only with the default administrator role
Version Introduced:
10.8

Description

The update operation enables read-only mode for your ArcGIS Enterprise deployment. It is recommended that read-only mode is enabled whenever you are upgrading your Enterprise deployment to ensure that no data loss or downtime occurs. When read-only mode is enabled, users will still be able to interact with your preexisting content. However, attempts to create or modify any data, such as creating a new user or updating the properties of a feature service, will be blocked. For more information on read-only mode, see Read-only mode in ArcGIS Enterprise.

Request parameters

ParameterDetails

isReadOnly

A boolean that specifies whether ArcGIS Enterprise 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

description

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.

Example
1
description=ArcGIS Enterprise is currently in read-only mode. Contact your administrator for further assistance.

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 that demonstrates enabling read-only mode:

1
2
3
4
5
6
POST /webadaptor/portaladmin/mode/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

isReadOnly=true&description=ArcGIS Enterprise is currently in read-only mode. Contact your administrator for further assistance&f=json

JSON Response example

1
2
3
4
{
  "status": "success",
  "messages": []
}

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