POST AgentBluePrint ApplyBluePrint

The POST /AgentBluePrint/ApplyBluePrint method is used to apply a blueprintClosed A snapshot of the certificate stores and scheduled jobs on one orchestrator, which can be used to create matching certificate stores and jobs on another orchestrator with just a few clicks. with associated certificate stores and scheduled jobs to an orchestratorClosed Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores.. This endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. returns 204 with no content upon success.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/agents/management/read/
/agents/management/modify/

Table 123: POST Agent BluePrint Apply BluePrint Input Parameters

Name In Description
templateId Query

A string indicating the Keyfactor Command GUID of the blueprint to apply to the orchestrator(s).

Use the GET AgentBluePrint method (see GET Agent BluePrint) to retrieve a list of all the blueprints to determine the blueprint GUIDs.

  Query Required. An array of strings indicating the GUIDs of the orchestrators to which the blueprint should be applied.

Use the GET Agents method (see GET Agents) to retrieve a list of all the orchestrators to determine the orchestrator GUIDs and current status of the orchestrators.

Note:  Orchestrators must be approved before a blueprint can be applied.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed A set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflowClosed A workflow is a series of steps necessary to complete a process. In the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the top of the Management Portal page next to the Log Out button.