Directory

URL:
https://<root>/system/directories/<directoryName>
Methods:
GET
Required Capability:
Access allowed with the "Security and Infrastructure" privilege
Version Introduced:
10.2.1

Description

The resource for an individual directory returns the properties of a directory. A directory is a file system-based folder that contains a specific type of content for the portal. The physicalPath property of a directory locates the actual path of the folder on the file system. Portal for ArcGIS supports local directories and network shares as valid locations.

During the Portal for ArcGIS installation, the setup program asks you for the root portal directory (that will contain all the portal's sub directories). However, you can change each registered directory through this API.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access an individual directory resource:

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/portaladmin/system/directories/testDirectory?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "name": "<name>",
  "physicalPath": "<path>",
  "directoryType": "<type>",
  "description": "<description>"
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "name": "content",
  "physicalPath": "D:\\arcgisportal\\content",
  "directoryType": "CONTENT",
  "description": "the default content directory"
}

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