Configuration Store

URL:
https://<root>/system/configstore
Methods:
GET
Operations:
Edit, Recover
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.1

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

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access the configstore resource:

1
https://machine.domain.com/webadaptor/admin/system/configstore?f=pjson

JSON Response syntax

1
2
3
4
5
6
7
{
  "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

1
2
3
4
5
6
7
{
  "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"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close