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 configstore resource returns all of the server's configurations. Typical configurations include all the resources such as clusters, machines, GIS services, and security rules that are required to power a site.
Every server machine, when it joins the site, is provided with a connection to the configuration store and it can thereafter participate in the management of the site. You can change the store's properties during runtime using the Edit operation.
The Administrator API that runs on every server machine is capable of reading and writing to the store. As a result, the store must be accessible to every server machine within the site. The default implementation is built on top of a file system and stores all the configurations in a hierarchy of folders and files.
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 configstore resource:
https://organization.example.com/<context>/admin/system/configstore?f=pjsonJSON Response syntax
{
"type": "FILESYSTEM", //only supported value for this property
"connectionString": "<connection_string>",
"class": "<class>",
"localRepositoryPath": "<localpathOnmachine>", //Added at 10.5
"status": "<Initializing|Ready>"
}JSON Response example
{
"type": "FILESYSTEM",
"connectionString": "C:\\arcgisserver\\config-store",
"class": "com.esri.arcgis.discovery.admin.store.file.FSConfigStore", //default class name for FILESYSTEM type
"localRepositoryPath": "C:\\arcgisserver\\local",
"status": "Ready"
}