- URL:
- https://<root>/services/deleteServices
- Methods:
POST- Version Introduced:
- 10.7.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.
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 generate 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.
Description
The delete operation deletes 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 ("folder ). When a service is deleted, the service is stopped, and all resources and configurations associated with the service are deleted.
Request parameters
| Parameter | Details |
|---|---|
| The folder name, service name, and type of service being started in JSON format. See the service properties table below. |
| The response format. The default response format is Values: |
Service properties
| Property | Details |
|---|---|
| The name of the folder containing the service. If the service resides in the root folder, leave the folder property blank ( Example |
| The name of the service. Example |
| The service type. Example |
Example usage
The following is a sample POST request for the delete operation:
POST /<context>/admin/services/deleteServices HTTP/1.1
Host: organization.example.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"}