System - Services

URL:: https://<root>/services/System
Methods:: GET
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.

Register data stores Feature layer Update Delete Security and infrastructure Servers Organization webhooks Geoprocessing Publisher role

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 generateToken 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.

Learn how to generate a token

Description

The System folder resource contains automatically deployed services used by ArcGIS Server. The following table outlines the services included in the System folder.

Service	Details
`CachingControllers`	The `CachingControllers` service is used by ArcGIS Server to create and manage map, globe and image service caches.
`CachingTools`	The `CachingTools` service is used by ArcGIS Server to create and manage map and image service caches.
`DistributedWorker`	A work item is opened on a machine in an ArcGIS Server cluster on behalf of a distributed geoprocessing tool.
`DynamicMappingHost`	This service is a multitenant map service provider.
`FeatureServiceTools`	The `FeatureServiceTools` service is used by a feature service to run various tools, for example, `CalculateFeatureService`.
`GeoAnalyticsManagement`	The `GeoAnalyticsManagement` service is used for the management of GeoAnalytics. Legacy The ArcGIS GeoAnalytics Server extension is deprecated with the release of ArcGIS Enterprise 11.4. The last ArcGIS Enterprise release with support for GeoAnalytics Server is 11.3.
`GeoAnalyticsTools`	The `GeoAnalyticsTools` service is provided for distributed analysis of large datasets. Legacy The ArcGIS GeoAnalytics Server extension is deprecated with the release of ArcGIS Enterprise 11.4. The last ArcGIS Enterprise release with support for GeoAnalytics Server is 11.3.
`LocationReferencingSystemTools`	The `LocationReferencingSystemTools` service is used for supporting asynchronous location referencing capabilities.
`OrthomappingTools`	The `OrthomappingTools` service is used by ArcGIS Server to provide distributed bundle block adjustment.
`ParcelFabricTools`	The `ParcelFabricTools` service is used for supporting asynchronous parcel fabric capabilities.
`PublishingTools`	The `PublishingTools` service is used by ArcGIS Server to publish service definition files as services.
`RasterAnalysisTools`	The `RasterAnalysisTools` service is used by ArcGIS Server to provide distributed raster analysis.
`RasterProcessing`	The `RasterProcessing` service is used by ArcGIS Server to process raster data.
`RasterProcessingGPU`	The `RasterProcessingGPU` service is used by ArcGIS Server to process raster data using GPU.
`RasterRendering`	The `RasterRendering` service is a multitenant raster rendering provider.
`RealityMappingTools`	The `RealityMappingTools` eoprocessing service is used by ArcGIS Server to support reality mapping workflows using the nFrames SURE engine.
`ReportingTools`	The `ReportingTools` service is used by ArcGIS Server to report the cache status for map and image service caches.
`SceneCachingControllers`	The `SceneCachingControllers` service is used by ArcGIS Server to create and manage scene service caches.
`SceneCachingTools`	The `SceneCachingTools` service is used by ArcGIS Server to create and manage scene service caches.
`SpatialAnalysisTools`	The `SpatialAnalysisTools` service is used for supporting spatial analysis capabilities in Portal for ArcGIS.
`SyncTools`	The `SyncTools` service is used by a feature service to synchronize your organization's GIS content.
`TopographicProductionSystemTools`	The `TopographicProductionSystemTools` service is used for supporting asynchronous topographic production capabilities.
`UtilityNetworkTools`	The `UtilityNetworkTools` service is used for supporting asynchronous utility network capabilities.
`ValidationTools`	The `ValidationTools` service is used for supporting asynchronous validation capabilities.
`VersionManagementTools`	The `VersionManagementTools` service is used for supporting asynchronous version management capabilities.

Request parameters

Parameter	Details
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

Example usage

The following is a sample request URL used to access the System folder resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/services/System?f=pjson

JSON Response example

Use dark colors for code blocksCopy
{
  "folderName": "System",
  "description": "The System folder contains automatically deployed services that are used by ArcGIS Server.",
  "webEncrypted": false,
  "isDefault": true,
  "services": [
    {
      "folderName": "System",
      "serviceName": "CachingControllers",
      "type": "GPServer",
      "description": "The CachingControllers service is used by ArcGIS Server to create and manage Map, Globe and Image service caches."
    },
    {
      "folderName": "System",
      "serviceName": "CachingTools",
      "type": "GPServer",
      "description": "The CachingTools service is used by ArcGIS Server to create and manage Map and Image service caches."
    },
    {
      "folderName": "System",
      "serviceName": "DistributedWorker",
      "type": "GPServer",
      "description": "Launches a work item on a machine in an ArcGIS Server cluster on behalf of a distributed geoprocessing tool."
    },
    {
      "folderName": "System",
      "serviceName": "DynamicMappingHost",
      "type": "MapServer",
      "description": "This service is multi-tenant map service provider."
    },
    {
      "folderName": "System",
      "serviceName": "FeatureServiceTools",
      "type": "GPServer",
      "description": "The FeatureServiceTools service is used by Feature Service to run various tools, e.g. CalculateFeatureService."
    },
    {
      "folderName": "System",
      "serviceName": "LocationReferencingSystemTools",
      "type": "GPServer",
      "description": "The LocationReferencingSystemTools service is used for supporting asynchronous Location Referencing capabilities."
    },
    {
      "folderName": "System",
      "serviceName": "OrthomappingTools",
      "type": "GPServer",
      "description": "The OrthomappingTools service is used by ArcGIS Server to provide distributed bundle block adjustment."
    },
    {
      "folderName": "System",
      "serviceName": "ParcelFabricTools",
      "type": "GPServer",
      "description": "The ParcelFabricTools service is used for supporting asynchronous Parcel Fabric capabilities."
    },
    {
      "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": "RasterAnalysisTools",
      "type": "GPServer",
      "description": "The RasterAnalysisTools service is used by ArcGIS Server to provide distributed raster analysis."
    },
    {
      "folderName": "System",
      "serviceName": "RasterProcessing",
      "type": "ImageServer",
      "description": "The RasterProcessing service is used by ArcGIS Server to process raster data."
    },
    {
      "folderName": "System",
      "serviceName": "RasterProcessingGPU",
      "type": "ImageServer",
      "description": "The RasterProcessingGPU service is used by ArcGIS Server to process raster data using GPU."
    },
    {
      "folderName": "System",
      "serviceName": "RasterRendering",
      "type": "ImageServer",
      "description": "The RasterRendering service is a multi-tenant raster rendering provider."
    },
    {
      "folderName": "System",
      "serviceName": "RealityMappingTools",
      "type": "GPServer",
      "description": "The RealityMappingTools Geoprocessing service is used by ArcGIS Server to support reality mapping workflow using nFrames SURE engine."
    },
    {
      "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."
    },
    {
      "folderName": "System",
      "serviceName": "SceneCachingControllers",
      "type": "GPServer",
      "description": "The SceneCachingControllers service is used by ArcGIS Server to create and manage Scene service caches."
    },
    {
      "folderName": "System",
      "serviceName": "SceneCachingTools",
      "type": "GPServer",
      "description": "The SceneCachingTools service is used by ArcGIS Server to create and manage Scene service caches."
    },
    {
      "folderName": "System",
      "serviceName": "SpatialAnalysisTools",
      "type": "GPServer",
      "description": "The SpatialAnalysisTools service is used for supporting Spatial analysis capability in Portal for ArcGIS."
    },
    {
      "folderName": "System",
      "serviceName": "SyncTools",
      "type": "GPServer",
      "description": "The SyncTools service is used by Feature Service to synchronize your organization's GIS content."
    },
    {
      "folderName": "System",
      "serviceName": "TopographicProductionSystemTools",
      "type": "GPServer",
      "description": "The TopographicProductionSystemTools service is used for supporting asynchronous Topographic Production capabilities."
    },
    {
      "folderName": "System",
      "serviceName": "UtilityNetworkTools",
      "type": "GPServer",
      "description": "The UtilityNetworkTools service is used for supporting asynchronous Utility Network capabilities."
    },
    {
      "folderName": "System",
      "serviceName": "ValidationTools",
      "type": "GPServer",
      "description": "The ValidationTools service is used for supporting asynchronous validation capabilities."
    },
    {
      "folderName": "System",
      "serviceName": "VersionManagementTools",
      "type": "GPServer",
      "description": "The VersionManagementTools service is used for supporting asynchronous Version Management capabilities."
    }
  ]
}