Service | ArcGIS REST APIs

URL:: https://<root>/<folder>/<serviceName>.<serviceType>
Methods:: GET
Operations:: Delete, Edit, Start, Stop, Statistics
Child Resources:: Item Info, Lifecycle Information
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 resource for an individual service returns the properties and service definition comprosing a GIS service. A service exposes GIS resources like maps, rasters, locators, and geodatabases through REST and SOAP interfaces. The type of the service is often dictated by the type of resource being published. In addition to accessing the underlying resource, a GIS service can expose additional capabilities called extensions (or server object extensions). Extensions are packages of custom functionality that can perform business logic or expose the service through additional formats or protocols.

When a service is started, it is ready to service requests from users. A service typically has one or more instances (objects) defined by the minInstancesPerNode and maxInstancesPerNode propeties in the service definition. The maxIdleTime parameter defines how long these objects are kept alive when not in use.

The status resource on the service describes the current state of the service. To get detailed information about the instances in your service, you can access the statistics resource.

Request parameters

Parameter	Description
`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 service resource:

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

JSON Response example

Use dark colors for code blocksCopy
{
  "serviceName": "Seattle",
  "type": "MapServer",
  "description": “my map service”,
  "capabilities": "map,query,data",
  "clusterName": "default",
  "minInstancesPerNode": 1,
  "maxInstancesPerNode": 2,
  "maxWaitTime": 60,
  "maxIdleTime": 1800,
  "maxUsageTime": 600,
  "recycleInterval": 24,
  "loadBalancing": "ROUND_ROBIN",
  "isolationLevel": "HIGH",
  "properties": {
    "maxBufferCount": "100",
    "virtualCacheDir": "https://GRID5:6080/arcgis/server/arcgiscache",
    "maxImageHeight": "2048",
    "maxRecordCount": "1000",
    "filePath": "\\\\machine\\data\\Seattle\\SEATTLE.msd",
    "maxImageWidth": "2048",
    "cacheOnDemand": "false",
    "virtualOutputDir": "https://GRID5:6080/arcgis/server/arcgisoutput",
    "outputDir": "C:\\arcgisserver\\arcgisoutput",
    "supportedImageReturnTypes": "MIME+URL",
    "isCached": "false",
    "ignoreCache": "false",
    "clientCachingAllowed": "false",
    "cacheDir": "C:\\arcgisserver\\arcgiscache\\Seattle"
  },
  "extensions": [
    {
      "typeName": "KmlServer",
      "capabilities": "SingleImage,SeparateImages,Vectors",
      "properties": {
        "minRefreshPeriod": "30",
        "compatibilityMode": "GoogleEarth",
        "imageSize": "1024",
        "dpi": "96",
        "endPointURL": "null",
        "featureLimit": "1000000",
        "useDefaultSnippets": "false"
      }
    },
    {
      "typeName": "WFSServer",
      "capabilities": null,
      "properties": {
        "appSchemaURI": "https://grid5:6080/arcgis",
        "appSchemaPrefix": "arcgis",
        "enableTransactions": "false"
      }
    },
    {
      "typeName": "WCSServer",
      "capabilities": "",
      "properties": {}
    }
  ],
  "frameworkProperties": {
    "javaHeapSize": "64"
  }
}