The GET /AgentBluePrint/{id}/Jobs method is used to retrieve details of the scheduled certificate store jobs 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 scheduled job details, including certificate stores.
Tip: The following permissions (see Security Roles and Claims) are required to use this feature:
/agents/management/read/
Table 119: GET Agent BluePrint {id} Jobs 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 120: GET Agent BluePrint {id} Jobs Response Data
| Name | Description |
|---|---|
| AgentBlueprintJobId | A string indicating the GUID of the certificate store job associated with the blueprint. |
| AgentBlueprintStoreId | A string indicating the GUID of the certificate store associated with the blueprint. |
| AgentBlueprintId | A string indicating the GUID of the blueprint. |
| JobType | A string indicating the GUID of the certificate store job type. |
| JobTypeName | A string indicating the certificate store job type (e.g. JksInventory). |
| OperationType | In integer indicating the type of operation (e.g. 2 = add to certificate store, 3 = remove from certificate store). |
| Thumbprint | A string indicating the thumbprint of the certificate to add to or remove from the certificate store. This field is populated only for management jobs. |
| Contents | A string containing the certificate to be added to the certificate store. This field is populated only for management add to certificate store jobs. |
| Alias | A string indicating the alias to be used for the certificate upon entry into or removal from the certificate store. The function of the alias varies depending on the certificate store type. For example, for a Java keystore, it is user-generated and stored in the keystore associated with the certificate while for PEM stores it is the thumbprint of the certificate. Some certificate store types don't require an alias and some do. See Add Certificate in the Keyfactor Command Reference Guide for more information. This field is populated only for management jobs. |
| PrivateKeyEntry | A Boolean indicating whether the certificate store has a separate private key file. This field is populated only for management jobs. |
| Overwrite | A Boolean indicating whether the certificate already in the certificate store should be overwritten with the new certificate, if applicable. This field is populated only for management jobs. |
| HasEntryPassword | A Boolean indicating whether the certificate in the certificate store has a different password from the certificate store itself. This field is populated only for management jobs. |
| HasPfxPassword | A Boolean indicating whether the certificate being added to the certificate store has a private key. This field is populated only for management jobs. |
| RequestTimestamp | A string indicating the time at which the management job was requested. This field is populated only for management jobs. |
| KeyfactorSchedule | An object containing the schedule for the certificate store job. This field is populated only for inventory and discovery jobs. |
| Subject | A string containing the reenrollment subject name using X.500 format. This field is populated only for reenrollment jobs. |
| Directories | A string containing the directory or directories to search during a discovery job. This field is populated only for discovery jobs. |
| IgnoredDirectories | A string containing the directories that should not be included in the search during discovery jobs. This field is populated only for discovery jobs. |
| SymLinks | A Boolean indicating whether the job should follow symbolic links on Linux and UNIX operating systems and report both the actual location of a found certificate store file in addition to the symbolic link pointing to the file during discovery jobs. This option is ignored on Windows. This field is populated only for discovery jobs. |
| Compatibility | A Boolean indicating whether the job will run using the compatibility mode introduced in Java version 1.8 to locate both JKS and PKCS12 type files (true) or not (false) during Java keystore discovery jobs. This field is populated only for discovery jobs. |
| FileExtensions | A string containing the file extensions for which to search during a discovery job. For example, search for files with the extension “jks” in order to exclude files with other extensions such as “txt”. This field is populated only for discovery jobs. |
| FileNamePatterns | A string against which to compare the file names of certificate store files and return only those that contain the specified string (e.g. myjks) during discovery jobs. This field is populated only for discovery jobs. |
| AgentBlueprintStores |
An object that includes the certificate store information of the job. |
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.