POST Custom Job Types

The POST /JobTypes/Custom method is used to create a custom orchestratorClosed Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. job type in Keyfactor Command. This method returns HTTP 200 OK on a success with a message body containing a list of custom job type details.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/agents/management/modify/

Table 416: POST JobTypes Custom Input Parameters

Name In Description
Job Type Name Body Required. A string containing the short name for the custom job type. This is used to reference the job type when submitting a job for it. This name should not contain spaces.
Description Body A string containing a description for the custom job type.
Job Type Fields Body

An array of job type fields that indicate the type of tasks the job type is designed to perform. ClosedShow job type field details.

For example:

Copy 
"JobTypeFields": [
   {
      "Name": "Favorite Type of Pet",
      "Type": "String",
      "DefaultValue": "Cat",
      "Required": true
   },
   {
      "Name": "Model Year of First Car",
      "Type": "Int"
   },
   {
      "Name": "Mother's Birthday",
      "Type": "DateTime"
   }
]

Table 417: POST JobTypes Custom Response Data

Name Description
Id The Keyfactor Command reference GUID for the custom job type. This ID is automatically set by Keyfactor Command.
Job Type Name A string containing the short name for the custom job type. This is used to reference the job type when submitting a job for it.
Description A string containing a description for the custom job type.
Job Type Fields

An array of job type fields that indicate the type of tasks the job type is designed to perform. ClosedShow job type field details.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which 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. endpoints can be called and results returned. It is intended to be used primarily 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. 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.