GET Netmap

Retrieves a netmap from the Secure Proxy Configuration Manager.

With the getNetmap/{netmapName} method, you can retrieve a predefined netmap from the Secure Proxy Configuration Manager.

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

Table 1. GET Netmap request details
Method Resource URI Description

GET

netmap

/sspcmrest/sspcm/rest/netmap/getNetmap/{netmapName}

Gets the XML corresponding to the netmap defined with in the Secure Proxy Configuration Manager.
Table 2. GET Netmap URI input parameters
Parameter Required or Optional Description Validation Valid values

netmapName

Required

The name of the netmap that is defined with in the Secure Proxy Configuration Manager.

Must be a non-empty string

a-zA-Z0-9_.
Table 3. GET Netmap response body parameters
Parameter Description

XML

The XML corresponding to the netmap.

HTTP Netmap request

The following example shows the HTTP request:

GET https://localhost:8443/sspcmrest/sspcm/rest/netmap/
getNetmap/Connect_Direct_Netmap
“X-Authentication”: 
“61504f4a524b48532b776a3467643733374b526368513d3d”

XML Netmap response

The following example shows the XML response:

<netmapDef>
<createdBy>admin</createdBy>
<createdTimestamp>2014-04-15 11:40:03 AM
</createdTimestamp>
<description>
<![CDATA[FTP_Netmap]]&gt;</description>
<forceToUnlock>true</forceToUnlock>
<inboundNodes><inboundNodeDef>
<description>
<![CDATA[Inbound]]&gt;</description>
<forceToUnlock>false</forceToUnlock>
<logLevel>DEBUG</logLevel>
<name>Inbound</name>
<peerAddressPattern>*</peerAddressPattern>
<policyId>FTP_Policy</policyId>
<secureConnection>false</secureConnection>
<verStamp>1</verStamp>
</inboundNodeDef>
</inboundNodes>
<lastModifiedBy>admin</lastModifiedBy>
<lastModifiedTimestamp>2014-04-15 11:40:03 AM
</lastModifiedTimestamp>
<lockedBy>admin</lockedBy>
<lockedTimestamp>2014-04-15 01:26:07 PM</lockedTimestamp>
<name>FTP_Netmap</name>
<outboundNodes><outboundNodeDef>
<addresses><address>
<nodeName>Outbound_Node_Name</nodeName>
<host>10.20.30.40</host>
<port>1663</port>
</address>
</addresses>
<forceToUnlock>false</forceToUnlock>
<logLevel>DEBUG</logLevel>
<name>Outbound_Node_Name</name>
<secureConnection>false</secureConnection>
<validDestination>10.20.30.40</validDestination>
<validDestinationPort>1663</validDestinationPort>
<verStamp>1</verStamp>
</outboundNodeDef>
</outboundNodes>
<protocol>ftp</protocol>
</netmapDef>