GET All Engines

Retrieves the IDs(names) of all the engines that exist within the Secure Proxy Configuration Manager.

With the getAllEngines method, you can retrieve the IDs(names) of the engines 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. GET Engine request details

GET Engine request details.

Method Resource URI Description

GET

engine

/sspcmrest/sspcm/rest/engine/getAllEngines

Gets the IDs(names) corresponding to the engines defined with in the Secure Proxy Configuration Manager.

Table 2. Get All Engines URI input parameters

Get All Engines URI input parameters

Parameter Required or Optional Description Validation Valid values

None

Not Required

Retrieves the IDs(names) of the engines that are defined with in Secure Proxy Configuration Manager.

None

None

Table 3. Get All Engines response body parameters

Get All Engines response body parameters

Parameter Description

Messages

The IDs(names) corresponding to all the engines.

HTTP Engine request

The following example shows the HTTP request:

GET https://localhost:8443/sspcmrest/sspcm/rest/engine/getAllEngines
“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>
    <objectsList>["MyEngine"]</objectsList>
    <results/>
    </XmlResponse>