POST ProcessingEngines/Engine/{engine guid}

Assigns a Platforms engine to one or more Policy folders for certificate processing.

Requirements

  • Permissions:  The caller must have Manage Policy permission to the Policy folder.
  • 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

{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

FolderGuids

Specify this parameter as part of the JSON body. An array of policy folder GUIDs that the Platform engine will manage. In the Policy tree, use the Policy value that appears on the Support tab. Depending on your environment, the GUID may be expressed with or without curly braces {}. For example, {3d6b61d-1c71-4603-883f-25b8c2ceecdd}.

Processing Engine Folder Guid

Returns

Response description

Name

Description

HTTP 201

For valid requests, POST ProcessingEngines/Engine/{engine guid} returns a Created message and the following data in the message body:

  • AddedCount: The number of Policy folders that successfully attached to the Platforms engine.
  • Errors: Any errors that occurred during processing.

HTTP 400

Returns Bad Request for the following reason:

  • Missing resource id: [EngineGuid].

  • Missing request parameter: [FolderGuids].

HTTP 401

Returns Unauthorized if the caller is missing the necessary permissions.

Example: Attach an engine to a Policy folder

Request

POST https://tpp.venafi.example/vedsdk/ProcessingEngines/engine/{c4152110-1ec9-4f62-99fe-869d66264c34}
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "FolderGuids":[
      "{067e26e2-5536-4a6d-915b-fbf28496125c}"
   ]
}

Response

HTTP/1.1 201 OK
{
    "AddedCount": 1,
    "Errors": []
}