GET ProcessingEngines/Folder/{folder guid}

Returns a list of all Platforms engines that are currently assigned to a Policy folder.

Requirements

  • Permissions: The caller must have View permission and Read permission to the Policy folder. The caller must also have View permission on the Platforms engine.
  • Token scope:  Configuration:Manage

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

Input parameters

Name

Description

{folder guid}

Specify this parameter as part of the URL. A GUID that uniquely identifies a Policy folder. Depending on your environment, the GUID may be expressed with or without curly braces {}. For example, {3d6b61d-1c71-4603-883f-25b8c2ceecdd}. In the Policy tree, use the Policy value that appears on the Support tab.

Processing Engine Folder Guid

Returns

Response description

Name

Description

HTTP 200

For valid requests, GET ProcessingEngines/Folder/{folder guid} returns a HTTP 200 message and the following data in the message body:

  • _links: An array of Hypertext Application Language (HAL)-based links to retrieve the next and previous page of results.
  •  Engines: If there is more than one, an array of policy folders:
    • EngineName: The processing engine name.
    • EngineGuid: The engine GUID.
    • EngineDN: The distinguished name of the processing engine.

HTTP 204

Returns NoContent when the policy folder has no processing engine assignments.

HTTP 400

Returns Bad Request for the following reason:

  • Missing resource id: [FolderGuid].

HTTP 401

Returns Unauthorized if the caller is missing the necessary permissions.

Example: List all Trust Protection Platform processing engines that are assigned to a folder

Request

GET https://tpp.venafi.example/vedsdk/ProcessingEngines/Folder/{067e26e2-5536-4a6d-915b-fbf28496125c}
Authorization:Bearer 4MyGeneratedBearerTknz==

Response

HTTP/1.1 200 OK
{
   "_links":{
      "self":{
         "Details":"/vedsdk/ProcessingEngines/Engine/%7Bc4332b03-72ec-469e-8255-14098924ab01%7D"
      }
   },
   "Engines":[
      {
         "EngineDN":"\\VED\\Engines\\Engine_1",
         "EngineGuid":"{067e26e2-5536-4a6d-915b-fbf28496125c}",
         "EngineName":"Engine_1"
      },
      {
         "EngineDN":"\\VED\\Engines\\Engine_2",
         "EngineGuid":"{c4332b03-72ec-469e-8255-14098924ab01%7D}",
         "EngineName":"Engine_2"
      }
   ]
}