- URL:
- https://<root>/mode/update
- Methods:
POST- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The update operation enables read-only mode for an ArcGIS Enterprise on Kubernetes organization. It is recommended that you enable read-only mode when upgrading a deployment to ensure that no data loss or downtime occurs. When read-only mode is enabled, users can interact with existing content, but they cannot create or modify data (such as creating a new user or updating the properties of a feature service).
Request parameters
| Parameter | Details |
|---|---|
(Required) | A Boolean that specifies whether the organization is in read-only mode. Read-only mode will block requests to modify or create data, including content, users, groups, and site settings. The default value is Values: |
| 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 custom message is provided, a default response is used. Example |
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the update operation:
POST /<context>/admin/mode/update HTTP/1.1
Host: organization.example.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-JRmaTsbRDaBHTQTePMzQePhXl7KcEG9Cfkw2sa7P1W1eJSON Response example
{
"status": "success",
"messages": []
}