- URL:
- https://<root>/mode
- Methods:
GET- Operations:
- Update Mode
- 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 mode resource returns whether your ArcGIS Enterprise deployment has been set to read-only mode. When enabled, the Enterprise portal, connected hosting and federated servers, and ArcGIS Data Stores are all set into read-only mode. During this time, most POST requests and administrative functions are blocked. Users within your organization will still be able to view and access your content; however, attempts to create, modify or delete content or site properties will be blocked. To learn more about read-only mode, see Read-only mode in ArcGIS Enterprise.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access the mode resource:
https://organization.example.com/<context>/portaladmin/mode?f=pjsonJSON Response example
Read-only mode disabled:
{"isReadOnly": false}Read-only mode enabled:
{
"isReadOnly": true,
"message": "ArcGIS Enterprise is currently in read-only mode. Contact your administrator for further assistance.",
"servers": ["k74NUJZhhtol35fv"]
}