Skip to content
URL:
https://<root>/system/configstore
Methods:
GET
Version Introduced:
12.0

Description

The configstore resource returns all of the server's configurations. Typical configurations include all the resources such machines, services, and security rules that are required to power a site. You can change the store's properties during runtime using the Edit operation.

The administrative 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

(Required)

The response format. The default response format is html.

Values: html | json | pjson

token

(Required)

Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

Example usage

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

Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/admin/system/configStore?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
    "connectionString": "<config-store location>",
    "configPersistenceType": "<persistence type>",
    "version": "<versionName>",
    "username": "<associatedUsername>",
    "status": "< ready | not ready >"
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
    "connectionString": "C:\\arcgisvideoserver\\config-store",
    "configPersistenceType": "FILESYSTEM",
    "version": "",
    "username": "",
    "status": "ready"
}

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