- URL:
- https://<root>/mode/update
- Methods:
POST- Version Introduced:
- 10.4
Access requirements
Required privileges
The Sever 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.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server 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 Server Administrator API must include a token in the request body.
Description
The update operation is used to move between the two types of site modes. Switching to READ mode will restart all your services as the default behavior. Moving to EDITABLE mode will not restart services.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The mode to which you will set your site. Values: |
(Optional) | Determines whether this operation must run asynchronously. Values: |
(Optional) | Specifies whether edits to feature services are allowed while a server is in read-only mode. The default value is Values: |
| The response format. The default response 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: []
siteMode=READ_ONLY&runAsync=true&allowEditingViaServices=false&f=pjsonJSON Response example
{"status": "success"}