Skip To Content
ArcGIS Developer

Edit (Service)


This operation edits the properties of a service. To edit a service, you need to submit the complete JSON representation of the service, which includes the updates to the service properties. Editing a service can cause the service to be restarted with updated properties.

The JSON representation of a service contains the following four sections:

  • Service description properties—Common properties that are shared by all services. These properties typically identify a specific service.
  • Service framework properties—Properties targeted toward the framework that hosts the GIS service. They define the life cycle and load balancing of the service.
  • Service type properties—Properties targeted toward the core service type as seen by the server administrator. Since these properties are associated with a server object, they vary across the service types.
  • Extension properties—Represent the extensions that are enabled on the service.

The JSON is submitted to the operation URL as a value of the parameter service. You can leave out the serviceName and type parameters in the JSON representation. Any other properties that are left out are not persisted by the server.

Request parameters



The JSON representation of the service and the properties that have been updated or added.



Introduced at 10.9.1. This parameter specifies whether the operation will run synchronously or asynchronously. If false, the operation is run synchronously. If true, the operation is run asynchronously and the response returns a JSON object containing job information that can be used to track the job's status. The default value is false.

Values: true | false


The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the edit operation, formatted for readability:

POST /context/admin/services/SampleService.MapServer/edit HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: []

  "description": "My updated map service",
  "serviceName": SampleServer
  "capabilities": "Map,Query,Data",
  "clusterName": "default",
  "maxInstancesPerNode": 1,
  "minInstancesPerNode": 1,
  "maxWaitTime": 60,
  "maxIdleTime": 180,
  "maxUsageTime": 600,
  "recycleInterval": 24,
  "recycleStartTime": "00:00",
  "loadBalancing": "ROUND_ROBIN",
  "isolationLevel": "HIGH",
  "keepAliveInterval": -1,
  "properties": {},
  "datasets": [],
  "type": "MapServer",
  "frameworkProperties": {},
  "extensions": [
      "typeName": "WMSServer",
      "enabled": false,
      "capabilities": "GetCapabilities,GetFeatureInfo,GetLegendGraphic,GetMap,GetSchemaExtension,GetStyles",
      "properties": {
        "minRefreshPeriod": "30",
        "compatabilityMode": "GoogleEarth",
        "imageSize": "1024",
        "dpi": "96",
        "endpointURL": "null",
        "featureLimit": "1000000",
        "useDefaultSnippets": "false"
      "typeName": "WFSServer",
      "enabled": true,
      "capabilities": "SingleImage,SeparateImages,Vectors",
      "properties": {}
      "typeName": "WCSServer",
      "enabled": true,
      "capabilities": "Create,Query,Update,Delete,Uploads",
      "properties": {}
  "properties": {
    "maxBufferCount": "100",
    "maxImageHeight": "2048",
    "maxRecordCount": 1000,
    "filePath": "/arcgis/framework/etc/data/SampleServer/",
    "maxImageWidth": "2048",
    "cacheOnDemand": "false",
    "virtualOutputDir": "/rest/directories/arcgisoutput",
    "supportedImageReturnTypes": "MIME+URL",
    "isCached": "false",
    "ignoreCache": "false",
    "clientCachingAllowed": "false",
    "cacheDir": "${arcgiscache}

JSON Response examples

If async is false, the following response is returned once a service is edited successfully:

{"status": "success"}

If async is true, the following response is returned. The value returned for jobsUrl can be used to access the job resource to track a job's status after it's been submitted. For more information, see the Job resource topic.

  "jobsUrl": "",
  "jobID": "ja2ca1a35-881c-400c-a49a-b26883002d6c",
  "jobStatus": "SUBMITTED"