Skip to main content
Version: 2.18.1

ICAP profile API setup guide

Overview​

The ICAP profile management API allows for creation and modification of ICAP profiles.

Creating a new ICAP profile​

1. Make a post request to the ICAP profile management API​

The API can be reached through Glasswall Halo's entry point. This entry point shares the same IP address/url as the portal.

  • To submit a new ICAP profile, send a post request to the/api/v1/profiles/<profile-name>Endpoint. Include a JSON request body that contains the profile.

Example:

{
  "status": "enabled",
  "profileSettings": {
    "contentManagementPolicy": "default",
    "processingRulesDefault": "block",
    "processingRules": {
      "application/msword": "process",
      "application/vnd.openxmlformats-officedocument.wordprocessingml.document": "process",
      ...
    }
  }
}

If the request body is valid, the response will contain a summary of the newly created profile.

2. Use the profile in ICAP server​

For ICAP to find and use the profile for processing, configure your ICAP client to send the profile name via aprofileQuery param to the ICAP server.

Example:

icap://icap-server.<cluster-ip>:1344/resp-cdr-service?profile=<profile-name>

For more information please refer to our API documentation.

Last updated on