- URL:
- https://<root>/mode/update
- Methods:
POST- Version Introduced:
- 10.8
Access requirements
Required privileges
The Portal 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 Portal 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 Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
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
| Parameter | Details |
|---|---|
| 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 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 message is entered, a default response is used. Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the update operation that demonstrates enabling read-only mode:
POST /<context>/portaladmin/mode/update HTTP/1.1
Host: organization.example.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=jsonJSON Response example
{
"status": "success",
"messages": []
}