POST Create ICAP Configuration

Edit online

Creates an ICAP Configuration on the Secure Proxy Configuration Manager.

With the icapConfig method, you can create an ICAP configuration on the IBM Secure Proxy Configuration Manager.

This API method requires authentication. The authentication token that is generated at login must be passed in through the "X-Authentication" header.

Table 1. Create ICAP Configuration request details

Create ICAP Configuration request details.
Method Resource URI Description

POST

ICAP Configuration

/sspcmrest/sspcm/rest/icapConfig

Creates a new ICAP Configuration on the IBM ® Secure Proxy Configuration Manager.
Table 2. Create ICAP Configuration request body parameters

Create ICAP Configuration request body parameters
Parameter Description

XML

The XML corresponding to creating a new ICAP definition within IBM ® Secure Proxy Configuration Manager.

HTTP ICAP Configuration request

The following example shows the HTTP request:

<icapConfigDef>
<createdBy>admin</createdBy>
<createdTimestamp>2024-06-06 12:24:43 PM</createdTimestamp>
<enableUnscannedExtension>true</enableUnscannedExtension>
<extnAppendToUnScanFile>unscanned</extnAppendToUnScanFile>
<fileExtensions>
<fileExtension>*</fileExtension>
</fileExtensions>
<forceToUnlock>false</forceToUnlock>
<formatVer>10</formatVer>
<formatVersion>2</formatVersion>
<icapConnErrorAction>failSession</icapConnErrorAction>
<lastModifiedBy>admin</lastModifiedBy>
<lastModifiedTimestamp>2024-06-06 12:24:43 PM</lastModifiedTimestamp>
<lockedBy>admin</lockedBy>
<lockedTimestamp>2024-06-06 12:25:26 PM</lockedTimestamp>
<maxFileSise>1024</maxFileSise>
<maxSessions>20</maxSessions>
<name>icapProfile44</name>
<previewScan>true</previewScan>
<properties>
<property>
<name>icap.connection.timeout.secs</name>
<value>60</value>
</property>
<property>
<name>icap.handshake.timeout.secs</name>
<value>180</value>
</property>
<property>
<name>icap.http.unscanned.header.key</name>
<value>SCAN_SKIPPED</value>
</property>
<property>
<name>icap.http.unscanned.header.value</name>
<value>true</value>
</property>
<property>
<name>icap.scan.buffer.size</name>
<value>131072</value>
</property>
<property>
<name>icap.service.profile.name</name>
<value>default</value>
</property>
<property>
<name>num.preview.bytes</name>
<value>1024</value>
</property>
<property>
<name>sftp.client.temp.ext.names</name>
<value>filepart</value>
</property>
</properties>
<responseTimeOut>180</responseTimeOut>
<retryLimit>3</retryLimit>
<secureConnection>true</secureConnection>
<serverAddress>10.120.180.255</serverAddress>
<serverPort>12345</serverPort>
<serverProvider>McAfee</serverProvider>
<serviceName>wwreqmod</serviceName>
<sslName>defSslInfo</sslName>
<status>locked</status>
<verStamp>1</verStamp>
</icapConfigDef>

XML ICAP Configuration response

The following example shows the XML response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<XmlResponse>
<httpCode>200</httpCode>
<httpStatus>OK</httpStatus>
<action>None</action>
<message>icapConfigDef icap_profile created.</message>
<messageLevel>INFO</messageLevel>
<results/>
</XmlResponse>