- URL:
- https://<root>/system/interceptors/[registeredInterceptor.interceptor]/edit
- Methods:
POST- Version Introduced:
- 12.0
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 ArcGIS 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 ArcGIS Server Administrator API generate operation. For security reasons, all POST requests made to the ArcGIS Server Administrator API must include a token in the request body.
Description
The edit operation updates select configuration properties of a registered service interceptor. This operation only modifies the values for the description, enabled, url, and properties properties.
Request parameters
| Parameter | Details |
|---|---|
(Required) | A JSON object containing the current configuration properties for a registered interceptor. The following properties can be modified:
Example |
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the edit operation:
POST /<context>/system/interceptors/ResponseEnrichment.interceptor/edit HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
interceptorJSON=[
{
"interceptorName": "ResponseEnrichment",
"displayName": "Response Enrichment Interceptor",
"interceptorClass": "com.esri.interceptor.samples.ResponseEnrichment",
"chainingOrder": 3,
"description": "Response Enrichment Interceptor",
"targetVersion": "12.2",
"enabled": true,
"urlPatterns": ["Hosted/newService/FeatureServer"],
"properties": {"prop1": "value1"}
}
]&f=pjson&token=<ACCESS_TOKEN>JSON Response example
{"status": "success"}