Skip To Content
ArcGIS Developer
Dashboard

Configuration Store

  • URL:https://<notebookserveradmin>/system/configstore
  • Required Capability:Administrator
  • Version Introduced:10.7

Description

The configuration store maintains configurations for ArcGIS Notebook Server. Typical configurations include all the resources such as machines and security rules that are required to power the site. In a way, the configuration store is a physical representation of a site.

Every ArcGIS Notebook Server machine is provided with a connection to the configuration store when it joins the site, and it can thereafter participate in the management of the site. You can change the store's properties during run time using the edit operation.

The Administrator API that runs on every server machine is capable of reading and writing to the store. For this reason, 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

JSON Response syntax

{
    "connectionString": "connectionstring",
    "configPersistenceType": "FILESYSTEM",
    "className": "classname",
    "status": "status"
}

JSON Response example

On a Windows machine

{
    "connectionString": "C:\\arcgisnotebookserver\\config-store",
    "configPersistenceType": "FILESYSTEM",
    "className": "com.esri.arcgis.carbon.persistence.impl.filesystem.FSConfigPersistence",
    "status": "ready"
}

On a Linux machine

{
    "connectionString": "/data/arcgis/notebookserver/usr/config-store",
    "configPersistenceType": "FILESYSTEM",
    "className": "com.esri.arcgis.carbon.persistence.impl.filesystem.FSConfigPersistence",
    "status": "ready"
}