Stop Services

URL:
https://<root>/services/stopServices
Methods:
POST
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
10.3

Description

This operation stops the specified services on all reachable server machines that are part of the site. This operation requires three properties: the folder name the service is located in (if applicable), the service's name, and the service type. If the service resides in the root folder, leave the folder property blank ("folderName": "" ). Once a service has been stopped, it cannot service any incoming requests.

Request parameters

ParameterDetails

services

The folder name, service name, and type of service being started in JSON format. See the Service properties table below.

f

The response format. The default response format is html.

Values: html | json | pjson

Service properties

PropertyDetails

folderName

The name of the folder containing the service. If the service resides in the root folder, leave the folder property blank ("folderName": "" ).

Example
1
2
3
4
5
//Root folder
"folderName": ""

//Specific folder
"folderName": "Planning"

serviceName

The name of the service.

Example
1
"serviceName": "SampleWorldCities"

type

The service type.

Example
1
"type": "MapServer"

Example usage

The following is a sample POST request for stopServices:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
POST /webadaptor/admin/services/stopServices HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

{
services=[{
  "folderName": "",
  "serviceName": "SampleWorldCities",
  "type": "MapServer"
},
{
  "folderName": "Planning",
  "serviceName": "FireHydrants",
  "type": "FeatureServer"
}]}&f=pjson

JSON Response example

1
{"status": "success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close