Access requirements
Required privileges
The Portal 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.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal 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 Portal Administrator API must include a token in the request body.
Description
The directories resource is a collection of directories that are used by the portal to store and manage content. There are five types of directories, four of which are returned by this endpoint:
- Content directory—The content directory contains the data associated with every item in the portal.
- Database directory—The built-in security store and sharing rules are stored in a Database server that places files in the database directory.
- Temporary directory—The temporary directory is used as a scratch workspace for all the portal's runtime components.
- Index directory—The index directory contains all the indexes associated with the content in the portal. The indexes are used for quick retrieval of information and for querying purposes.
The fifth is the log directory, which contains text files that are created when errors and warnings are encountered. Information for the log directory can be viewed in Log Settings resource, and its settings can be updated using the Edit Log Settings operation.
Request parameters
| Parameter | Details |
|---|---|
| The response format parameter. The default response format is Values: |
Example usage
The following is a sample request URL used to access the directories resource:
https://organization.example.com/<context>/portaladmin/system/directories?f=jsonJSON Response syntax
{
"directories": [
Directory1,
Directory2,
...
]
}JSON Response example
{
"directories": [
{
"name": "content",
"physicalPath": "D:\\arcgisportal\\content",
"directoryType": "CONTENT",
"description": ""
},
{
"name": "index",
"physicalPath": "D:\\arcgisportal\\index",
"directoryType": "INDEX",
"description": ""
},
{
"name": "db",
"physicalPath": "D:\\arcgisportal\\db",
"directoryType": "DB",
"description": ""
},
{
"name": "temp",
"physicalPath": "D:\\arcgisportal\\temp",
"directoryType": "TEMP",
"description": ""
}
]
}