- URL:
- https://<root>/system/configstore/edit
- Methods:
POST- Version Introduced:
- 10.1
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.
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 edit operation updates the configuration store. Typically, this operation is used to change the location of the store.
When ArcGIS Server is installed, the default configuration store uses local paths. As the site grows (more server machines are added), the location of the store must be updated to use a shared file system path. On the other hand, if you know at the onset that your site will have two or more server machines, you can start from a shared path while creating a site and skip this step altogether.
Request parameters
| Parameter | Details |
|---|---|
| Type of the configuration store. Values: |
| A file path or connection URL to the physical location of the store. Example |
| A file path or connection URL to the physical location of the local repository for when the site is in read-only mode. Example |
| A boolean to indicate if you want to move the content of the current store to the new store. The default is Values: |
| Decides if this operation must run asynchronously. Values: |
| The response format. The default response format is Values: |
Example usage
The folowing is a sample POST request for the edit operation:
POST /<context>/admin/system/configstore/edit HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
type=FILESYSTEM&connectionString=C:\arcgis\arcgisserver\config-store&localRepositoryPath=C:\arcgisserver\local&move=true&runAsync=true&f=pjsonJSON Response example
{"status": "success"}