PUT Import ICAP Configuration

Imports the exported ICAP Configuration to the IBM ® Secure Proxy Configuration Manager.

With the import method, you can import exported ICAP Configuration definition in to the IBM ® Secure Proxy Configuration Manager.

This API method requires authentication, and therefore the authentication token generated at login must be passed in through the "X-Authentication" header.

Table 1. Import ICAP Configuration request details
Import ICAP Configuration request details.
Method	Resource	URI	Description
`PUT`	`ICAP Configuration`	/sspcmrest/sspcm/rest/icapConfig/import	Imports the ICAP configuration defintion with the XML provided

Table 2. Import ICAP Configuration URI input parameters
Import ICAP Configuration URI input parameters
Parameter	Required or Optional	Description	Validation	Valid values
none	Not required	Imports exported ICAP Configuration with the new XML	None	None

Import ICAP Configuration example

The following example shows the HTTP request.

HTTP ICAP Configuration request

<sspCMConfigTag>
<formatVersion>
3</formatVersion>
<icapConfigsTag>
<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></lockedBy>
<lockedTimestamp></lockedTimestamp>
<maxFileSise>1024</maxFileSise>
<maxSessions>20</maxSessions>
<name>icapProfile</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>1234</serverPort>
<serverProvider>McAfee</serverProvider>
<serviceName>wwreqmod</serviceName>
<sslName>defSslInfo</sslName>
<status></status>
<verStamp>1</verStamp>
</icapConfigDef>
</icapConfigsTag>
</sspCMConfigTag>

HTTP 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>Import operation successful.</message>
    <messageLevel>INFO</messageLevel>
    <results/>
</XmlResponse>