Register Directory

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

Description

The register operation registers a new server directory. While registering the server directory, you can also specify the directory's cleanup parameters.

Request parameters

ParameterDetails

name

The name of the server directory.

Example
Use dark colors for code blocksCopy
1
name=Test Directory

physicalPath

The absolute physical path of the server directory.

Example
Use dark colors for code blocksCopy
1
physicalPath=C:/arcgis/arcgisserver/directories/testDirectory

diretoryType

The type of server directory.

Example
Use dark colors for code blocksCopy
1
directoryType=OUTPUT

cleanupMode

Defines if files in the server directory needs to be cleaned up. The default value is NONE.

Example
Use dark colors for code blocksCopy
1
cleanupMode=TIME_ELAPSED_SINCE_LAST_MODIFIED

maxFileAge

Defines how long a file in the directory needs to be kept before it is deleted.

Example
Use dark colors for code blocksCopy
1
maxFileAge=10

description

(Optional)

A 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 register operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /webadaptor/admin/system/directories/register HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

name=Test Directory&physicalPath=C:/arcgis/arcgisserver/directories/testDirectory&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.