- URL:
- https://<root>/system/directories/register
- 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 register operation registers a new server directory. While registering the server directory, you can also specify the directory's cleanup parameters.
Request parameters
| Parameter | Details |
|---|---|
| The name of the server directory. Example |
| The absolute physical path of the server directory. Example |
| The type of server directory. Example |
| Defines if files in the server directory needs to be cleaned up. The default value is Example |
| Defines how long a file in the directory needs to be kept before it is deleted. Example |
(Optional) | A description for the server directory. Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the register operation:
POST /<context>/admin/system/directories/register HTTP/1.1
Host: organization.example.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=pjsonJSON Response example
{"status": "success"}