GET ProcessingEngines/Engine/{engine guid}

Returns information about all policy folders that are under the management of a processing engine.

Requirements

  • Permissions: The caller must have View permission on the Policy folder. The caller must also have View permission and Read permission on the Platforms engine.
  • 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

Input parameters

Name

Description

{engine guid}

Specify this parameter as part of the URL. A GUID that uniquely identifies a Platforms engine. To get the Engine GUID, call GET ProcessingEngines or use the UI. For example, in the Platforms tree, use the Venafi Platform value that appears on the Support tab.

Platforms Engine Guid

Returns

Response description

Name

Description

HTTP 200

For valid requests, GET ProcessingEngines/Engine/{engine 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.
  •  Folders: If there is more than one, an array of policy folders:

    • Name: The policy folder name.

    • FolderGuid: The policy folder GUID.

    • FolderDN: The distinguished name of the policy folder.

HTTP 204

Returns NoContent when the processing engine has no policy folder 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 the Policy folders that are attached to a Platforms engine

Request

GET https://tpp.venafi.example/vedsdk/ProcessingEngines/Engine/{c4152110-1ec9-4f62-99fe-869d66264c34}
Authorization:Bearer 4MyGeneratedBearerTknz==

Response

HTTP/1.1 200 OK
{
   "_links":{
      "self":{
         "href":"/vedsdk/ProcessingEngines/Folder/%7Bc4332b03-72ec-469e-8255-14098924ab01%7D"
      }
   },
   "Folders":[
      {
         "FolderDN":"\\VED\\Policy\\TestPolicy_1",
         "FolderGuid":"{067e26e2-5536-4a6d-915b-fbf28496125c}",
         "FolderName":"TestPolicy_1"
      }
   ]
}