- URL:
- https://<root>/system/directories/<directory>
- Methods:
GET- Operations:
- Clean, Edit, Unregister
- 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. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.
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
This resource for an individual server directory returns the directory's properties.
Server directories are used by GIS services as a location to output items such as map images, tile caches, and geoprocessing results. In addition, some directories contain configurations that power the GIS services. In a site with more than one server machine these directories must be available on network shares, accessible to every machine in the site.
The following directory types can be registered with the server:
Output—Stores various information generated by services, such as map images. Instances: One or moreCache—Stores tile caches used by map, globe, and image services for rapid performance. Instances: One or moreJobs—Stores results and other information from geoprocessing services. Instances: One or moreSystem—Stores files that are used internally by the GIS server. Instances: One
Server directories that contain output of various GIS services can be periodically cleaned to remove old unused files. By using the cleanup mode and maximum file age parameters, you control when you would like the files in these directories to be cleaned.
All the output server directories are automatically virtualized, meaning that they can be accessed over a URL, for you through the ArcGIS REST API.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access an individual directory resource:
https://organization.example.com/<context>/admin/system/directories/arcgisoutput?f=pjsonJSON Response syntax
{
"name": "<name>",
"physicalPath": "<path>",
"directoryType": "<type>",
"cleanupMode": "<cleanup_mode>",
"maxFileAge": <age>,
"description": "<description>",
"virtualPath": "<virtual_path>"
}JSON Response example
{
"name": "arcgiscache",
"physicalPath": "\\\\server\\arcgisserver\\arcgiscache",
"directoryType": "CACHE",
"cleanupMode": "NONE",
"maxFileAge": 0,
"description": "Stores tile caches used by map, globe, and image services for rapid performance.",
"virtualPath": "/rest/directories/arcgiscache"
}