Objects

Software Title Summary Object

The information in the Software Title Summary object must match the information in the Software Title object that shares id. None of the following values can be null. In addition, the id cannot include any special characters or spaces.


Key	Value Type	Value Description
`name`	String	Name of the patch management software title.
`publisher`	String	Publisher of the patch management software title.
`lastModified`	String	Jamf Pro uses this key to display the Last Updated value in the computer inventory information. Note: Must be ISO-8601 format.
`currentVersion`	String	Used for reporting the latest version of the patch management software title to Jamf Pro.
`id`	String	Uniquely identifies this software title on the external source. Note: An `id` cannot be duplicated on an individual external source.

Software Title Object

The information in the Software Title object must match the information in the Software Title Summary object that shares id. None of the following values can be null. In addition, the id cannot include any special characters or spaces.


Key	Value Type	Value Description
`name`	String	Name of the patch management software title.
`publisher`	String	Publisher of the patch management software title.
`appName`	String	Deprecated
`bundleId`	String	Deprecated
`lastModified`	String	Jamf Pro uses this key to display the Last Updated value in the computer inventory information. Note: Must be ISO-8601 format.
`currentVersion`	String	Used for reporting the latest version of the patch management software title to Jamf Pro.
`requirements`	Array of criteria objects	Criteria used to determine which computers in your environment have this software title installed.
`patches`	Array of patch objects	Software title version information; one patch is one software title version. Note: Must be listed in descending order with the newest version at the top of the list.
`extensionAttributes`	Array of extensionAttributes objects	Extension attributes that are required by Jamf Pro to use this software title. Terms must be accepted in Jamf Pro.
`id`	String	String that uniquely identifies this software title on the external source. Note: An `id` cannot be duplicated on an individual external source.

criteria Object

The following values correspond with a row in a smart computer group or advanced search.

Note:

Criteria objects in an array must be ordered in the same way that smart group criteria is ordered.


Key	Value Type	Value Description
`name`	String	Any valid Jamf Pro smart group criteria. When type is `extensionAttribute`, the name value is the key defined in the `extensionAttribute` object.
`operator`	String	Any valid Jamf Pro smart group operator for the given name.
`value`	String	Search value for the smart group criteria.
`type`	String	Valid values are `recon` for everything other than extension attribute, and `extensionAttribute` for extension attributes.
`and`	Boolean	`true` specifies an `and` operator. `false` specifies an `or` operator. Optional. Defaults to `true` if not specified.

patch Object


Key	Value Type	Value Description
`version`	String	Version associated with this patch.
`releaseDate`	String	Date that this patch version was released.
`standalone`	Boolean	`true` specifies a patch that can be installed by itself. `false` specifies a patch that must be installed incrementally. Note: Used for reporting purposes. It is not used by patch policy processes.
`minimumOperatingSystem`	String	Lowest macOS version capable of installing this patch. Note: Used for reporting purposes. It is not used by patch policy processes. See the capabilities array for patch policy implementation.
`reboot`	Boolean	`true` specifies that the computer must be restarted after the patch policy has completed successfully. `false` specifies that the computer will not be restarted
`killApps`	Array of killApp objects	Specifies processes that will be stopped before a patch policy runs.
`components`	Array of component objects	Defines the elements that comprise this patch version. Note: Only one element is supported by Jamf Pro at this time.
`capabilities`	Array of criteria objects	Criteria used to determine which computers in your environment have the ability to install and run this patch.
`dependencies`	Array of criteria objects	Not currently used by Jamf Pro. Note: Cannot be a `null` value.

extensionAttributes Object


Key	Value Type	Value Description
`key`	String	Identifier unique within Jamf Pro. It is used by criteria objects and displayed in the Jamf Pro computer inventory information. Note: Duplicate keys are not allowed.
`value`	String	Base64 encoded macOS script. Standard extension attribute script which must return a `result`.
`displayName`	String	Used on the Jamf Pro Patch Management > Extension Attributes tab.

killApps Object


Key	Value Type	Value Description
`bundleId`	String	Bundle identifier of the applications that will be stopped before a patch policy runs.
`appName`	String	Name of the application that will be stopped before a patch policy runs.

components Object


Key	Value Type	Value Description
`name`	String	Name of the patch management software title.
`version`	String	Version associated with this patch.
`criteria`	Array of criteria objects	Criteria used to determine which computers in your environment have this patch version installed.