- URL:
- https://<root>/services/<ServiceName>.<ServiceType>/webhooks/deleteAll
- Methods:
POST- Version Introduced:
- 11.1
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.
To access webhook-related endpoints, administrators must be assigned a custom role that includes any of the privileges listed above in addition to the Feature layer, Geoprocessing, or Organization webhooks privileges.
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 permanently deletes all configured webhooks for a geoprocessing or feature service. If you want to temporarily deactivate all webhooks for a service, rather than deleting them, use the deactivate operation.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the delete operation, deleting all webhooks for a specific geoprocessing service:
POST /<context>/admin/services/myService.GPServer/webhooks/deleteAll HTTPS/1.1
Host: organization.example.com
Content-type: application/x-www-form-urlencoded
Content-Length: []
f=pjson&token=m7zGSezM7znt6ZuIwr827imJxOTSDsjYujVdd7SiAQLYG1HmesG8EbSnTwCbiekEh0QwRdmeyp1hP63M60TPrdZQ2NzIg5G7qFaQh40MdiOCfh60-6oPKC2MNoqwdVDZ3srzreVZb66QofWXws8GMrKWkgP45A-2an5crKvReUo-pwvkzm68W87Q0yPJFA2Kww39UnMYNw-5qd2-Bt04VmkrqKI-lCbA-jFZY_UGzeGzNqnBGrjKuVB_q17HogMwThe following is a sample POST request for the delete operation, deleting all webhooks for a specific feature service:
POST /<context>/admin/services/myService.FeatureServer/webhooks/ deleteAll HTTPS/1.1
Host: organization.example.com
Content-type: application/x-www-form-urlencoded
Content-Length: []
f=pjson&token=m7zGSezM7znt6ZuIwr827imJxOTSDsjYujVdd7SiAQLYG1HmesG8EbSnTwCbiekEh0QwRdmeyp1hP63M60TPrdZQ2NzIg5G7qFaQh40MdiOCfh60-6oPKC2MNoqwdVDZ3srzreVZb66QofWXws8GMrKWkgP45A-2an5crKvReUo-pwvkzm68W87Q0yPJFA2Kww39UnMYNw-5qd2-Bt04VmkrqKI-lCbA-jFZY_UGzeGzNqnBGrjKuVB_q17HogMwJSON Response example
{"status": "success"}