GET Agent BluePrint ID

The GET /AgentBluePrint/{id} method is used to retrieve information about the orchestratorClosed Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. 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 the specified blueprint GUID. This method returns HTTP 200 OK on a success with information about the blueprint.

Tip:  To see the certificate stores or scheduled jobs associated with the blueprint, use the GET /AgentBluePrint/{id}/Jobs method (see GET Agent BluePrint ID Jobs) or GET /AgentBluePrint/{id}/Stores method (see GET Agent BluePrint ID Stores).
Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/agents/management/read/

Table 115: GET Agent BluePrint {id} Input Parameters

Name In Description
id Path Required. A string indicating the GUID of the orchestrator blueprint that should be retrieved.

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

Table 116: GET Agent BluePrint {id} 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 and time the blueprint was created.
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.