GET Export SOCKS5 Proxy Servers

Exports all SOCKS5 Proxy Servers within the Secure Proxy Configuration Manager.

With the export method, you can retrieve the SOCKS5 Proxy Servers that exist within the 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. EXPORT SOCKS5 Proxy Server request details
EXPORT SOCKS5 Proxy Server request details.
Method	Resource	URI	Description
`GET`	`socksProxyConfig`	/sspcmrest/sspcm/rest/socksProxyConfig/export	Exports the xml corresponding to the EAServers defined with in the Secure Proxy Configuration Manager.

Table 2. Export All SOCKS5 Proxy Servers URI input parameters
Export All SOCKS5 Proxy Servers URI input parameters
Parameter	Required or Optional	Description	Validation	Valid values
None	Not Required	Exports the xml of the SOCKS5 Proxy Servers that are defined with in Secure Proxy Configuration Manager	None	None

Table 3. Export All SOCKS5 Proxy Servers response body parameters
Export All SOCKS5 Proxy Servers response body parameters
Parameter	Description
XML	The xml corresponding to all the SOCKS5 Proxy Servers in export format

Export All EAServers example

The following example shows the HTTP request.

HTTP EAServers request

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

XML EAServers response

The following example shows the XML response.

<sspCMConfigTag>
   <formatVersion>3</formatVersion>
   <socksProxyConfigsTag>
      <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>
      <socksProxyConfigDef>
         <authRequired>true</authRequired>
         <createdBy>admin</createdBy>
         <createdTimestamp>2020-11-30 11:51:24 AM</createdTimestamp>
         <forceToUnlock>false</forceToUnlock>
         <formatVer>10</formatVer>
         <formatVersion>2</formatVersion>
         <lastModifiedBy>admin</lastModifiedBy>
         <lastModifiedTimestamp>2020-11-30 11:51:24 AM</lastModifiedTimestamp>
         <lockedBy />
         <lockedTimestamp />
         <name>socksSecondTest</name>
         <properties>
            <property>
               <name>prop.key1</name>
               <value>value1</value>
            </property>
            <property>
               <name>prop.key2</name>
               <value>value2</value>
            </property>
         </properties>
         <serverAddress>host</serverAddress>
         <serverPort>231</serverPort>
         <status />
         <verStamp>1</verStamp>
      </socksProxyConfigDef>
   </socksProxyConfigsTag>
</sspCMConfigTag>