POST AgentBluePrint GenerateBluePrint

The POST /AgentBluePrint/GenerateBluePrint method is used to create a new 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. based on the certificate stores and scheduled jobs of one orchestratorClosed Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores.. This method returns HTTP 200 OK on a success with details of the new blueprint.

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

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

Table 124: POST Agent BluePrint Generate Input Parameters

Name In Description
agentIds Body Required. A string indicating the GUID of the orchestrator that should be used to generate the blueprint.

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.
name Body Required. A string indicating the name for the new blueprint.

Table 125: POST Agent BluePrint Generate Response Data

Name Description
AgentBlueprintId A string indicating the GUID of the blueprint.
Name A string indicating the name of the blueprint.
RequiredCapabilities An array of strings indicating the type of capabilities required by the orchestrators to which the blueprint will be applied (e.g. JKS, PEM).
lastModified A string indicating the date the blueprint was generated in UTC time.
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.