GET Adapter

Retrieves an adapter from the IBM ® Secure Proxy Configuration Manager.

With the getAdapter/{adapterName} method, you can retrieve a predefined adapter from the IBM ® 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 Adapter request details
GET Adapter request details.
Method	Resource	URI	Description
`GET`	`adapter`	/sspcmrest/sspcm/rest/adapter/getAdapter/{adapterName}	Gets the XML corresponding to the adapter defined with in the IBM ® Secure Proxy Configuration Manager.

Table 2. GET Adapter URI input parameters
GET Adapter URI input parameters
Parameter	Required or Optional	Description	Validation	Valid values
adapterName	Required	The name of the adapter that is defined with in the IBM ® Secure Proxy Configuration Manager.	Must be a non-empty string	a-zA-Z0-9_.

Table 3. GET Adapter response body parameters
GET Adapter response body parameters
Parameter	Description
XML	The XML corresponding to the adapter.

HTTP Adapter request

The following example shows the HTTP request:

GET https://localhost:8443/sspcmrest/sspcm/rest/adapter/getAdapter/CD_Adapter
“X-Authentication”: “61504f4a524b48532b776a3467643733374b526368513d3d”

XML Adapter 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>
    <messageLevel>INFO</messageLevel>
    <results>
    <entry>
    <key>XML</key>
    <value><cdAdapterDef>
    <createdBy>admin</createdBy>
    <createdTimestamp>2014-04-15 11:40:01 AM</createdTimestamp>
    <description>
    <![CDATA[CD_Adapter_Description]]&gt;</description>
    <encryptionLevel>true</encryptionLevel>
    <forceToUnlock>false</forceToUnlock>
    <formatVer>10</formatVer>
    <lastModifiedBy>admin</lastModifiedBy>
    <lastModifiedTimestamp>2014-04-15 11:40:01 AM</lastModifiedTimestamp>
    <listenPort>25000</listenPort>
    <lockedBy>admin</lockedBy>
    <lockedTimestamp>2014-04-15 11:46:07 AM</lockedTimestamp>
    <logLevel>DEBUG</logLevel>
    <maxSessions>20</maxSessions>
    <name>CD_Adapter</name>
    <netmap>Connect_Direct_Netmap</netmap>
    <netmapKey>ccenterdev03.irv.ustx.ibm.com</netmapKey>
    <pingResponse>Ping</pingResponse>
    <properties>
    <property>
    <name>a</name>
    <value>11</value>
    </property>
    <property>
    <name>b</name>
    <value>2</value>
    </property>
    </properties>
    <protocol>cd</protocol>
    <psOutPortrange>10-20</psOutPortrange>
    <sessionTimeout>90</sessionTimeout>
    <standardRoute>ccenterdev03.irv.ustx.ibm.com</standardRoute>
    <status>locked</status>
    <urlRoutingType>standardRouting</urlRoutingType>
    <verStamp>1</verStamp>
    </cdAdapterDef>
    </value>
    </entry>
    </results>
    </XmlResponse>