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. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.
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 mode resource returns the current mode for the server site. ArcGIS Server allows you to control changes to your site. You can set the site mode to READ to disallow the publishing of new services and block most administrative operations. Your existing services will continue to function as they did previously. Note that certain administrative operations such as adding and removing machines from a site are still available in READ mode.
The default site mode is EDITABLE, which means all administrative and publishing operations are allowed on the site. By default, all services will be restarted when the site mode is set to READ. Additionally, setting the site mode to READ will copy the site configuration files to a local repository on each machine in the site. This default behaviour will enable the site to operate in a degraded capacity when there are connection failures to the configuration store.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Response properties
| Property | Details |
|---|---|
| The current mode of the site. Response can be |
| Whether the site configuration files will be copied to the local repository upon switching to |
| Time stamp indicating the last time the site mode was modified. |
Example usage
The following is a sample request URL used to access the mode resource:
https://organization.example.com/<context>/admin/mode?f=pjsonJSON Response example
{
"siteMode": "READ_ONLY",
"copyConfigLocal": true,
"lastModified": <timestamp>
}