GET Perimeter Server

Edit online

Retrieves a Perimeter Server from the Secure Proxy Configuration Manager.

With the getPerimeterServer/{Perimeter Server Name} method, you can retrieve a predefined Perimeter Server on the 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. GET Perimeter Server request details

Get Perimeter Server request details.
Method Resource URI Description

Get

Perimeter Server

/sspcmrest/sspcm/rest/perimeterServer/getPerimeterServer/{Perimeter Server Name}

Get the XML corresponding to the Perimeter Server defined with in the Secure Proxy Configuration Manager.
Table 2. GET Perimeter Server URI input parameters

Get Perimeter Server URI input parameters

Parameter Required or Optional Description Validation Valid values

Perimeter Server Name

Required

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

Must be a non-empty string

A-Z a-z 0-9 ._-

Get Perimeter Server response body parameters

Table 3. Get Perimeter Server response body parameters

GET Perimeter Server response body parameters
Parameter Description

XML

The XML corresponding to the Perimeter Server.

HTTP Perimeter Server request

The following example shows the HTTP request.

GET https://localhost:8443/sspcmrest/sspcm/rest/perimeterServer/
getPerimeterServer/LessSecureZone1
“X-Authentication”: 
“61504f4a524b48532b776a3467643733374b526368513d3d”

XML Perimeter Server response

The following example shows the XML response.


<perimeterServerDef>
<createdBy>admin</createdBy>
<createdTimestamp>2014-04-15 01:00:16 PM</createdTimestamp>
<dnsResolution>false</dnsResolution>
<forceToUnlock>false</forceToUnlock>
<formatVer>10</formatVer>
<lastModifiedBy>admin</lastModifiedBy>
<lastModifiedTimestamp>2014-04-15 01:00:16 PM</lastModifiedTimestamp>
<listenPort>50000</listenPort>
<localHost>*</localHost>
<localPort>50000</localPort>
<lockedBy>admin</lockedBy>
<lockedTimestamp>2014-04-15 01:01:57 PM</lockedTimestamp>
<name>MyPerimeterServer</name>
<psInboundHighWaterMark>256000</psInboundHighWaterMark>
<psInboundLowWaterMark>153600</psInboundLowWaterMark>
<psOutboundHighWaterMark>256000</psOutboundHighWaterMark>
<psOutboundLowWaterMark>153600</psOutboundLowWaterMark>
<reverseConnect>true</reverseConnect>
<status>locked</status>
<type>PERIMETER_SERVER_MORE_SECURE</type>
<verStamp>1</verStamp>
</perimeterServerDef>
</perimeterServerDef>