The GET /AgentBluePrint/{id}/Stores method is used to retrieve details of the certificate stores for the orchestrator
Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. blueprint 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 a list of all the blueprint certificate store details.
Tip: The following permissions (see Security Roles and Claims) are required to use this feature:
/agents/management/read/
Table 121: GET Agent BluePrint {id} Stores 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. |
| PageReturned | Query | An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1. |
| ReturnLimit | Query | An integer that specifies how many results to return per page. The default is 50. |
| SortField | Query | A string containing the property by which the results should be sorted. Fields available for sorting through the API for the most part match those that appear as sortable columns in the Keyfactor Command Management Portal. The default sort field is StorePath. |
| SortAscending | Query | An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending. |
Table 122: GET Agent BluePrint {id} Stores Response Data
| Name | Description |
|---|---|
| AgentBlueprintStoreId | A string indicating the GUID of the certificate store associated with the blueprint. |
| AgentBlueprintId | A string indicating the GUID of the blueprint. |
| StorePath | A string indicating the path to the certificate store on the target. The format for this path will vary depending on the certificate store type. For example, for a Java keystore, this will be a file path (e.g. /opt/myapp/store.jks). See Adding or Modifying a Certificate Store in the Keyfactor Command Reference Guide for more information. |
| ContainerId | An integer indicating the ID of the certificate store's associated certificate store container, if applicable (see GET Certificate Store Containers). |
| CertStoreType | An integer indicating the ID of the certificate store type, as defined in Keyfactor Command, for this certificate store. Built-in certificates store types are: (0-Javakeystore, 2-PEMFile, 3-F5SSLProfiles,4-IISRoots, 5-NetScaler, 6-IISPersonal, 7-F5WebServer, 8-IISRevoked, 9-F5WebServerREST, 10-F5SSLProfilesREST, 11-F5CABundlesREST, 100-AmazonWebServices, 101-FileTransferProtocol). Any custom extensions for the Keyfactor Universal Orchestrator you add will have certificate store types numbered 102+. |
| CertStoreTypeName | A string indicating a reference name for the certificate store type (e.g. Java Keystore, PEM File). |
| Approved | A Boolean indicating whether a certificate store is approved (true) or not (false). If a certificate store is approved, it can be used and updated. A certificate store that has been discovered using the discover feature but not yet marked as approved will be false here. |
| CreateIfMissing | A Boolean indicating whether a new certificate store should be created with the information provided (true) or not (false). This option is only valid for Java keystores and any custom certificate store types you have defined to support this functionality. |
| Properties | Some types of certificate stores have additional properties that are stored in this parameter. The data is stored in a series of, typically, key value pairs that define the property name and value (see GET Certificate Store Types for more information). |
Tip: See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor API 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 workflow 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.
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 workflow 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.