- URL:https://<directory-url>/edit
(POST only)
- Required Capability:Default administrator role
- Version Introduced:10.1
Description
The server directory's edit operation allows you to change the path and clean up properties of the directory. This operation updates the GIS service configurations (and points them to the new path) that are using this directory, causing them to restart. It is therefore recommended that any edit to the server directories be performed when the server is not under load. This operation is mostly used when growing a single-machine-site to a multiple-machine-site configuration, which requires that the server directories and configuration store be put on a network-accessible file share.
Note:
You cannot edit the properties of UPLOADS, KML, INDEX, JOBREGISTRY, and INPUT directory types. These types are maintained internally by the server under the umbrella of the SYSTEM directory type. GIS services that reference server directories in their configuration are updated automatically and restarted.Request parameters
| Parameter | Details |
|---|---|
| name | The name of the directory being updated. Example |
| physicalPath | The absolute physical path of the server directory. Example |
| cleanupMode | Defines whether files in the server directory need to be cleaned up. Values: NONE | TIME_ELAPSED_SINCE_LAST_MODIFIED |
| maxFileAge | Defines how long a file in the directory needs to be kept (in days) before it is deleted. Example |
| description | An optional description for the server directory. Example |
| f | The response format. The default response format is html. Values: html | json| pjson |
Example usage
Below is a sample POST request for edit:
POST /webadaptor/admin/system/directories/arcgisoutput/edit HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
name=arcgisoutput&physicalPath=C:\arcgis\arcgisserver\directories\arcgisoutput&directoryType=OUTPUT&description=Stores various information generated by services, such as map images.&cleanupMode=TIME_ELAPSED_SINCE_LAST_MODIFIED&maxFileAge=10&f=jsonJSON Response example
{"status": "success"}