- URL:https://<directories-url>/register
(POST only)
- Required Capability:Default administrator role
- Version Introduced:10.1
Description
This operation registers a new server directory. While registering the server directory, you can also specify the directory's cleanup parameters.
Note:
You can also register a directory by using its JSON representation as a value of the directory parameter.Request parameters
| Parameter | Details |
|---|---|
| name | The name of the server directory. Example |
| physicalPath | The absolute physical path of the server directory. Example |
| diretoryType | The type of server directory. Example |
| cleanupMode | Defines if files in the server directory needs to be cleaned up. The default value is NONE. Example |
| maxFileAge | Defines how long a file in the directory needs to be kept 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 register:
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=jsonJSON Response example
{"status": "success"}