Edit Directory

URL:
https://<root>/system/directories/<directory>/edit
Methods:
POST
Required Capability:
Access allowed only with the default administrator role
Version Introduced:
10.1

Description

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

Request parameters

ParameterDetails

name

The name of the directory being updated.

Example
Use dark colors for code blocksCopy
1
name=arcgisoutput

physicalPath

The absolute physical path of the server directory.

Example
Use dark colors for code blocksCopy
1
physicalPath=C:\arcgis\arcgisserver\directories\arcgisoutput

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
Use dark colors for code blocksCopy
1
maxFileAge=10

description

An optional description for the server directory.

Example
Use dark colors for code blocksCopy
1
description=Stores various information generated by services, such as map images.

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the edit operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
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=pjson

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

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