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 a profile query 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.