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

AgentManagement: Modify

Table 314: POST JobTypes Custom Input Parameters

Name In Description
JobTypeName 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.
JobTypeFields 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:

"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 315: 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.
JobTypeName 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.
JobTypeFields

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