GET SOCKS5 Proxy Server

Edit online

Retrieves a SOCKS5 Proxy Server from the IBM ® Secure Proxy Configuration Manager.

With the getSocksProxyProfile/{SOCKS5 Proxy ServerName} method, you can retrieve a predefined SOCKS5 Proxy Server on 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 SOCKS5 Proxy Server request details

Get SOCKS5 Proxy Server request details.
Method Resource URI Description

GET

socksProxyConfig

/sspcmrest/sspcm/rest/socksProxyConfig/getSocksProxyProfile/{SOCKS5 Proxy ServerName}

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

Get SOCKS5 Proxy Server URI input parameters

Parameter Required or Optional Description Validation Valid values

SOCKS5 Proxy Server Name

Required

The name of the SOCKS5 Proxy Server that is defined with in IBM ® Secure Proxy Configuration Manager.

Must be a non-empty string

A-Z a-z 0-9 ._-
Table 3. Get SOCKS5 Proxy Server response body parameters

GET SOCKS5 Proxy Server response body parameters
Parameter Description

XML

The XML corresponding to the SOCKS5 Proxy Server

HTTP EA Server request

The following example shows the HTTP request:

GET https://localhost:8443/sspcmrest/sspcm/rest/socksProxyConfig/getSocksProxyProfile/socksProxyProfile2
“X-Authentication”: “61504f4a524b48532b776a3467643733374b526368513d3d”

XML EA Server response

The following example shows the XML response.
<socksProxyConfigDef>
   <authRequired>true</authRequired>
   <createdBy>admin</createdBy>
   <createdTimestamp>2020-11-30 11:42:30 AM</createdTimestamp>
   <forceToUnlock>false</forceToUnlock>
   <formatVer>10</formatVer>
   <formatVersion>2</formatVersion>
   <lastModifiedBy>admin</lastModifiedBy>
   <lastModifiedTimestamp>2020-11-30 11:42:30 AM</lastModifiedTimestamp>
   <lockedBy>admin</lockedBy>
   <lockedTimestamp>2020-11-30 11:47:09 AM</lockedTimestamp>
   <name>socksProxyProfile2</name>
   <properties>
      <property>
         <name>prop.key</name>
         <value>prop.value</value>
      </property>
   </properties>
   <serverAddress>localhost</serverAddress>
   <serverPort>9999</serverPort>
   <status>locked</status>
   <verStamp>1</verStamp>
</socksProxyConfigDef>