GET Engine

Retrieves an engine definition from the Secure Proxy Configuration Manager.

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

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

Table 3. GET Engine response body parameters
GET Engine response body parameters
Parameter	Description
XML	The XML corresponding to the engine.

HTTP Engine request

The following example shows the HTTP request:

GET https://localhost:8443/sspcmrest/sspcm/rest/engine/getEngine/MyEngine
“X-Authentication”: “61504f4a524b48532b776a3467643733374b526368513d3d”

XML Engine 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><engineDef>
<blacklistUserId></blacklistUserId>
<blacklistUserIp></blacklistUserIp>
<createdBy>admin</createdBy>
<createdTimestamp>2024-06-06 12:10:38 PM</createdTimestamp>
<debugLogging>ERROR</debugLogging>
<description>
<![CDATA[dd]]></description>
<enableAuditLogRouting>false</enableAuditLogRouting>
<forceToUnlock>false</forceToUnlock>
<formatVer>10</formatVer>
<formatVersion>2</formatVersion>
<host>cc</host>
<lastModifiedBy>admin</lastModifiedBy>
<lastModifiedTimestamp>2024-06-06 12:10:38 PM</lastModifiedTimestamp>
<localBindAddress></localBindAddress>
<localPSLogging>ERROR</localPSLogging>
<lockedBy>admin</lockedBy>
<lockedTimestamp>2024-06-06 12:11:00 PM</lockedTimestamp>
<maverickLogging>ERROR</maverickLogging>
<name>Eng1</name>
<port>63366</port>
<properties>
<property>
<name>proxy.host.ip</name>
<value></value>
</property>
<property>
<name>ps.shutdown.timeout.secs</name>
<value>60</value>
</property>
</properties>
<status>locked</status>
<userStore>defUserStore</userStore>
<verStamp>1</verStamp>
</engineDef>
    </value>
    </entry>
    </results>
    </XmlResponse>