Administer service interceptors

Once you have developed and packaged your service interceptor as a .interceptor file, you can manage it using the administrative operations in ArcGIS Server. This includes deploying the interceptor, updating its configuration, enabling or disabling it, modifying its properties, updating or unregistering it, and chaining multiple interceptors together.

ArcGIS Server provides a set of administrative REST APIs to perform these actions.

Deploy service interceptors

Deploying a service interceptor involves two steps: uploading the package file and registering it with ArcGIS Server.

Upload service interceptors

To upload a service interceptor, follow these steps:

1. Sign in to the ArcGIS Server Administrative Directory. The Administrative Directory is typically available at https://gisserver.domain.com:6443/arcgis/admin.

2. Click Home > uploads > upload.

3. Click Choose File and select the interceptor file you want to upload.

4. Click Upload.

   

5. After the interceptor is uploaded, copy its Item ID, which is required during the registration process.

   

Register service interceptors

Once you've uploaded a service interceptor, follow these steps to register it:

1. Navigate to https://gisserver.domain.com:6443/arcgis/admin/system/interceptors.

2. Click register.

3. Paste the Item ID you copied in the previous workflow and click Register.

   

The service interceptor is deployed successfully and added to the list of interceptor files. For each service interceptor you register, you can view the file name, the interceptor name, and the chaining order. The number listed next to an interceptor name represents the chaining order.

View and edit service intercptor configuration

To view a service interceptor's configuration details, click its name on the list of registered service interceptors. This will display the interceptor configuration in JSON format, as shown below.

To edit the interceptor configuration values, click on edit. You can only edit the values for enabled, urlPatterns, and properties.

• enabled—Allowed values are true and false. Set it to true to activate the interceptor, or false to disable it. This is effective for temporarily turning off an interceptor during maintenance or troubleshooting.

• urlPatterns—Update this value to change which services are intercepted. Ensure the new pattern aligns with the intended target services.

• properties—Modify existing key-value pairs used by the interceptor logic.

  Note: You should only update the values of existing properties. Modifying or removing property names may break the interceptor's logic.

  

Once you've updated the values, click Save Edits to save and apply the changes.

Update service interceptors

You can update a registered service interceptor (for example, when deploying a newer version for code fixes or enhancements) by reuploading the same package file and using the update operation. The steps for updating an interceptor file are the same as those for uploading a service interceptor. After uploading the updated file, follow these steps to register the interceptor with ArcGIS Server:

1. Navigate to https://gisserver.domain.com:6443/arcgis/admin/system/interceptors.

2. Click update.

3. Paste the Item ID of the interceptor and click Update.

   

Unregister service interceptors

To unregister a service interceptor, follow these steps:

1. Navigate to https://gisserver.domain.com:6443/arcgis/admin/system/interceptors.

2. Click unregister.

3. Enter the service interceptor file name and click Unregister.

   

After unregistering a service interceptor, you can use the same interceptor file to re-register it if needed.

Edit interceptor chaining order

When multiple interceptors are registered, ArcGIS Server supports chaining, where interceptors execute in a specified order. The chaining order determines the sequence of execution. The interceptor with the lowest order value is executed first. The order is displayed next to the interceptor name in the ArcGIS Server Administrator Directory (for example, AuditLogInterceptor-1).

To edit a chaining order, follow these steps:

1. Navigate to https://gisserver.domain.com:6443/arcgis/admin/system/interceptors.

2. Click chainingorder.

3. Update the chainingOrder parameter by assigning a unique numeric value to each interceptor.

   

4. Click Save Edits.

   

   Note: It is recommended that you avoid assigning the same chaining order to multiple service interceptors to prevent unwanted behavior.