- URL:
- https://<root>/services/deleteServices
- Methods:
POST- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise 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.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise 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 Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The delete operation deletes specified services from an ArcGIS Enterprise on Kubernetes. Once the services are deleted, the services are stopped and all pods and microservices associated with the services are also deleted.
Request parameters
| Parameter | Details |
|---|---|
| A comma-separated list of services, represented as a JSON object containing the folders containing the services, the services' names, and the service types. For information on the service property types, see the Service properties section below. Example |
| Indicates whether to process the operation in synchronous or asynchronous mode. The default value is Values: |
Service properties
| Parameter | Details |
|---|---|
| The name of the folder containing the service. If the service resides in the root folder, leave the folder property blank. Example |
| The service name. 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={"services": [{"folderName": "","serviceName": "SampleWorldCities1","type": "MapServer"},{"folderName": "","serviceName": "SampleWorldCities2","type": "MapServer"}]}&async=false&token=ZgttNXW27AaT6bUAz7GpI_9pSaOgYdoOSbr_lBFtmNPdva513X7i_C3VPlVoTMlrfFjj-UPpITLbFBaeczh20XVHxv3n4Kr9ZfUTdJc1lG913JoyNsAzWK9eoTi31NFIOzzFkshS2wLRqRXmPob48zCP7yXtQIAQl6PR4q1P1UvdM2en5ag3tF4juCewecAW7GiJaw5Vza0W7vHUffDddnbFQGHqNMfoFx1-BDBZPxsPOamPNF8TurlCJVZpabBjJSON Response example
{"status": "success"}