GET ProcessingEngines

Returns a list off all processing engines. Platforms engines manages certificate processing for a policy folder. Platforms engines manages certificate processing for a policy folder.

Requirements

  • Permissions: The caller must have View permission on each Platform engine. Otherwise, the processing engine does not appear in the list.
  • Token scope:   Configuration

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

None. Make sure the URL ends with a trailing slash. Otherwise, some environments, such as cURL and PowerShell return a HTTP 307 Temporary Redirect message.

Returns

Response description

Name

Description

HTTP 200

For valid requests, GET ProcessingEngines returns a HTTP 200 message and the following data in the message body:

  • Engines: A list of information about each Platforms engine:

    • _links: self, and href with a Hypertext Application Language (HAL)-based link for this Platforms engine.

    • EngineDN: The Distinguished Name (DN) of a Platforms engine.

    • EngineGuid: A GUID that uniquely identifies a Platforms engine.

    • EngineName: The Platforms engine name.

HTTP 307

If the method is missing a slash (/) at the end of the URL or between the query parameters, this message appears: There is no operation listening for [Web SDK method], but there is an operation listening for [Web SDK method/], so you are being redirected there.

HTTP 400

Returns Bad Request for invalid URL.

Example: List all Platforms engines

Request

GET https://tpp.venafi.example/vedsdk/ProcessingEngines/
Authorization:Bearer 4MyGeneratedBearerTknz==

Response

HTTP/1.1 200 OK
{
   "Engines":[
      {
         "_links":{
            "self":{
               "href":"/vedsdk/ProcessingEngines/Engine/%7B269eef3b-f9ed-443a-bfd3-12fe619569a0%7D"
            }
         },
         "EngineDN":"\\VED\\Engines\\WIN-MLK71Q10559",
         "EngineGuid":"{269eef3b-f9ed-443a-bfd3-12fe619569a0}",
         "EngineName":"WIN-MLK71Q10559"
      },
      {
         "_links":{
            "self":{
               "href":"/vedsdk/ProcessingEngines/Engine/%7B112adf57-07b7-41fe-9d3a-5f342e421c68%7D"
            }
         },
         "EngineDN":"\\VED\\Engines\\Engine_1",
         "EngineGuid":"{112adf57-07b7-41fe-9d3a-5f342e421c68}",
         "EngineName":"Engine_1"
      },
      {
         "_links":{
            "self":{
               "href":"/vedsdk/ProcessingEngines/Engine/%7B14aaa945-be24-4590-9817-72edd9cc3352%7D"
            }
         },
         "EngineDN":"\\VED\\Engines\\Engine_2",
         "EngineGuid":"{14aaa945-be24-4590-9817-72edd9cc3352}",
         "EngineName":"Engine_2"
      }
   ]
}