- URL:https://<services-url>/stopServices
- Required Capability:Default administrator role | All authorized privileges
- Version Introduced:10.3
Description
This operation stops the desired services on all reachable server machines in the cluster. This operation requires three properties: folder name, service name, and service type. Once a service has been stopped, it cannot service any incoming requests.
Note:
Clusters have been deprecated. The use of clusters for new deployments is strongly discouraged, and existing deployments are advised to migrate away from use of clusters as part of ongoing maintenance and upgrades.
Request parameters
| Parameter | Details |
|---|---|
| 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
| Property | Details |
|---|---|
| folderName | The name of the folder containing the service. If the service resides in the root folder, leave the folder property blank ("folderName": ""). Example |
| serviceName | The name of the service. Example |
| type | The service type. Example |
Example usage
The following is a sample POST request for stopServices, formatted for readability:
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=jsonJSON Response example
{"status": "success"}