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

AgentManagement: Read
AgentManagement: Modify

Table 89: POST AgentBluePrint 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 90: POST AgentBluePrint 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. 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.).
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).