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 Overview) are required to use this feature:

AgentManagement: Read

Table 80: GET AgentBluePrint {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 81: GET AgentBluePrint {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. JKSClosed A Java KeyStore (JKS) is a file containing security certificates with matching private keys. They are often used by Java-based applications for authentication and encryption., PEMClosed A PEM format certificate file is a base64-encoded certificate. Since it's presented in ASCII, you can open it in any text editor. PEM certificates always begin and end with entries like ---- BEGIN CERTIFICATE---- and ----END CERTIFICATE----. PEM certificates can contain a single certificate or a full certifiate chain and may contain a private key. Usually, extensions of .cer and .crt are certificate files with no private key, .key is a separate private key file, and .pem is both a certificate and private key.).
LastModified A string indicating the date and time the blueprint was created.
Tip:  For code examples, see the Keyfactor API Endpoint Utility. To find the embedded web copy of this utility, click the help icon () at the top of the Keyfactor Command Management Portal page next to the Log Out button.