- URL:
- https://<root>/services/<folder>
- Methods:
GET- Operations:
- Delete Folder, Edit Folder, Rename Service
- Child Resources:
- Report, Service
- 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
The resource for an individual folder returns the folder's properties, including its description and the services it contains. ArcGIS Server supports a single level hierarchy of folders. By grouping services within a folder, you can conveniently set permissions on them as a single unit. A folder inherits the permissions of the root folder when it is created, but you can change those permissions at a later time.
Request parameters
| Parameter | Description |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access an individual folder resource:
https://organization.example.com/<context>/admin/services/testFolder?f=pjsonJSON Response syntax
{
"folderName": "<folder_name>",
"description": "<description>",
"services": [<full_service_name1>, <full_service_name2>]
}JSON Response example
{
"folderName": "System",
"description": "The System folder contains automatically deployed services that are used by ArcGIS Server.",
"services": [
{
"folderName": "System",
"serviceName": "CachingTools",
"type": "GPServer",
"description": "The CachingTools service is used by ArcGIS Server to create and manage map service caches."
},
{
"folderName": "System",
"serviceName": "PublishingTools",
"type": "GPServer",
"description": "The PublishingTools service is used by ArcGIS Server to publish service definition files as services."
},
{
"folderName": "System",
"serviceName": "ReportingTools",
"type": "GPServer",
"description": "The ReportingTools service is used by ArcGIS Server to report cache status for Map and Image service caches."
}
]
}