GET Applications

The GET /Applications operation retrieves all certificate store applications. Query parameters support filtering using defined criteria, control over pagination by specifying the page number and return limit, and customization of sorting based on specified fields and order. On success, the operation returns HTTP 200 OK with  applications details.

Tip:  Previous versions of Keyfactor Command referred to the certificate store applications as containers.
Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:
/certificate_stores/read/
OR
/certificate_stores/read/#/

Permissions for certificate stores can be set at the system-wide level or certificate store application level. See Application Permissions for more information.

In permission strings, # represents a specific resource identifier. In /certificate_stores/ permission strings it refers to a certificate store application ID (for example, containerId).

Table 257: GET Applications Input Parameters

Name In Description
QueryString Query

A string containing a query to limit the results (for example, field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to: Searching Certificate Store Applications. The query fields supported for this operation are:

  • HasSchedule (True, False)
  • Id
  • Name (Short Name)
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. Very large values can result in long processing time.
SortField Query

A string containing the property by which the results should be sorted. Fields available for sorting through the API include:

  • CertStoreType

  • Id

  • Name

Available sort fields are affected by the query provided in QueryString. The default sort field is Name.
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 258: GET Applications Response Data

Name

Description
Id

An integer indicating the ID of the application.
Name

A string indicating the name of the application.
Overwrite Schedules A Boolean indicating whether the schedule set on the application will overwrite schedules set individually on the certificate stores (True or False).
Schedule

A string containing the inventory schedule set for the application.

Schedules are displayed in cron-style syntax:

  • Interval schedules use I_mm, where mm is the number of minutes (for example, I_30 for every 30 minutes)
  • Daily schedules use D_hh:mm, where hh:mm is the run time (for example, D_14:30 for 2:30 PM)
Cert Store Type

An integer indicating the ID of the certificate store type, as defined in Keyfactor Command, for this application. A value of -1 indicates that the application is not associated with a certificate store type.

Note:  This parameter is considered deprecated and may be removed in a future release.
StoreCount An integer indicating the number of stores associated with the application.
Tip:  See the Keyfactor APIClosed An API is 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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended for validation, testing, and workflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development, and also serves as an interactive supplement to this API documentation. You can access it from the help menu () in the Management Portal.