Skip to main content
Tools Reference

Jamf Pro Tools

Written By Christopher Scaminaci

Last updated 7 days ago

Jamf Pro Tools

jamf_ · 1292 tools · Free 661 · Pro 631Apple device management for Mac, iPhone, iPad and Apple TV. Both vendor surfaces ship through one connection: the Jamf Pro API and the older Classic API. Classic reads answer JSON while Classic writes answer XML, so bodies are passed through exactly as sent. The credential is an API client id and secret created on your own Jamf server, and the base address is that server - Jamf Cloud or self-hosted. Paging on the Jamf Pro API is a zero-based page with a page size capped at 200 here and RSQL filters; the Classic API does not page at all. Jamf publishes no rate limit. Ids come from each resource's list tool. Every delete, every device command that acts on hardware - erase, wipe, lock, clear passcode, restart, Lost Mode, unmanage - and every wholesale update is destructive, because Jamf updates replace rather than merge: a policy sent without its scope ends up with no scope.

All connector tools · Jamf Pro setup guide

Jamf Pro tool groups

Advanced Computer Searches (Classic API)

ToolPlanAccessSummary
jamf_classic_create_advancedcomputersearches_idProWriteCreates a new advanced computer search.
jamf_classic_delete_advancedcomputersearches_idProDestructiveDeletes a computer search by ID.
jamf_classic_delete_advancedcomputersearches_nameProDestructiveDeletes a computer search by name.
jamf_classic_get_advancedcomputersearches_idFreeRead-onlyFinds computer searches by ID.
jamf_classic_get_advancedcomputersearches_nameFreeRead-onlyFinds advanced computer searches by name.
jamf_classic_list_advancedcomputersearchesFreeRead-onlyFinds all advanced computer searches.
jamf_classic_update_advancedcomputersearches_idProDestructiveUpdates an existing advanced computer search by ID.
jamf_classic_update_advancedcomputersearches_nameProDestructiveUpdates an existing advanced computer search by name.

[Jamf Pro] Creates a new advanced computer search. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID to filter by

[Jamf Pro] Deletes a computer search by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a computer search by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds computer searches by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds advanced computer searches by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all advanced computer searches. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing advanced computer search by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing advanced computer search by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName to filter by

Computer Application Usage (Classic API)

ToolPlanAccessSummary
jamf_classic_get_computerapplicationusage_idFreeRead-onlyFinds computer application usage by computer ID.
jamf_classic_get_computerapplicationusage_macaddressFreeRead-onlyFinds computer application usage by computer MAC address.
jamf_classic_get_computerapplicationusage_nameFreeRead-onlyFinds computer application usage by computer name.
jamf_classic_get_computerapplicationusage_serialnumberFreeRead-onlyFinds computer application usage by computer serial number.
jamf_classic_get_computerapplicationusage_udidFreeRead-onlyFinds computer application usage by computer UDID.

[Jamf Pro] Finds computer application usage by computer ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
idstringyesID value to filter by
startDatestringyesStart date (e.g. yyyy-mm-dd)

[Jamf Pro] Finds computer application usage by computer MAC address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
macaddressstringyesMAC address to filter by
startDatestringyesStart date (e.g. yyyy-mm-dd)

[Jamf Pro] Finds computer application usage by computer name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
namestringyesName to filter by
startDatestringyesStart date (e.g. yyyy-mm-dd)

[Jamf Pro] Finds computer application usage by computer serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
serialnumberstringyesSerial number to filter by
startDatestringyesStart date (e.g. yyyy-mm-dd)

[Jamf Pro] Finds computer application usage by computer UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
startDatestringyesStart date (e.g. yyyy-mm-dd)
udidstringyesUDID to filter by

Computer Applications (Classic API)

ToolPlanAccessSummary
jamf_classic_get_computerapplications_applicationFreeRead-onlyFinds computer applications by name.
jamf_classic_get_computerapplications_application_inventoryFreeRead-onlyFinds computer applications by name with additional display fields.
jamf_classic_get_computerapplications_application_versionFreeRead-onlyFinds computer applications by name and version.
jamf_classic_get_computerapplications_application_version_invFreeRead-onlyFinds computer applications by name and version.

[Jamf Pro] Finds computer applications by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
applicationstringyesApplication name to filter by

[Jamf Pro] Finds computer applications by name with additional display fields. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
applicationstringyesApplication name to filter by
inventorystringyesInventory options

[Jamf Pro] Finds computer applications by name and version. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
applicationstringyesApplication name to filter by
versionstringyesVersion to filter by

[Jamf Pro] Finds computer applications by name and version. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
applicationstringyesApplication name to filter by
inventorystringyesInventory options
versionstringyesVersion to filter by

Computer Check-In (Classic API)

ToolPlanAccessSummary
jamf_classic_list_computercheckinFreeRead-onlyFinds the Jamf Pro computer checkin information.
jamf_classic_update_computercheckinProDestructiveUpdates the Jamf Pro computer checkin information.

[Jamf Pro] Finds the Jamf Pro computer checkin information. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates the Jamf Pro computer checkin information. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.

Computer Commands (Classic API)

ToolPlanAccessSummary
jamf_classic_create_computercommands_commandProDestructiveCreates a new computer command using command name.
jamf_classic_create_computercommands_command_idProDestructiveCreates a new computer command using command name and device IDs.
jamf_classic_get_computercommands_nameFreeRead-onlyFinds all computer commands by name.
jamf_classic_get_computercommands_uuidFreeRead-onlyFinds a computer command by UUID.
jamf_classic_list_computercommandsFreeRead-onlyFinds all computer commands.

[Jamf Pro] Creates a new computer command using command name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this issues a live Apple MDM command to the Macs named in the XML body. The vendor spec does not enumerate the allowed command names; the set in use includes EraseDevice, DeviceLock, UnmanageDevice, ClearPasscode, EnableRemoteDesktop, DisableRemoteDesktop and the harmless BlankPush. EraseDevice returns a Mac to factory settings and cannot be undone. Read the command name and the target list in the body before you send it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
commandstringyesPath parameter 'command'.

[Jamf Pro] Creates a new computer command using command name and device IDs. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE, AND IT FANS OUT: id is a comma-separated list of computer IDs, for example 8,10,55, so one call sends the command to every Mac on it. The vendor spec does not enumerate the allowed command names; the set in use includes EraseDevice, DeviceLock, UnmanageDevice, ClearPasscode, EnableRemoteDesktop, DisableRemoteDesktop and the harmless BlankPush. Count the IDs and confirm the command name before you send it; an EraseDevice against a long list returns every Mac on it to factory settings, and Jamf Pro cannot undo it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
commandstringyesCommand to send (EnableRemoteDesktop and DisableRemoteDesktop require macOS 10.14.4)
idstringyesComputer ID - supports comma separated values (e.g. id/8,10,55)

[Jamf Pro] Finds all computer commands by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds a computer command by UUID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
uuidstringyesUUID to filter by

[Jamf Pro] Finds all computer commands. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

Computer Extension Attributes

ToolPlanAccessSummary
jamf_create_computer_extension_attributesProWriteCreate Computer Extension Attribute.
jamf_create_computer_extension_attributes_historyProWriteAdd specified Computer Extension Attribute history object notes.
jamf_delete_computer_extension_attributesProDestructiveRemove specified Computer Extension Attribute.
jamf_delete_multiple_computer_extension_attributesProDestructiveDelete multiple Computer Extension Attribute at once.
jamf_get_computer_extension_attributesFreeRead-onlyGet specified Computer Extension Attribute object.
jamf_get_computer_extension_attributes_templatesFreeRead-onlyGet specified Computer Extension Attribute Template object.
jamf_list_computer_extension_attributesFreeRead-onlyRetrieve Computer Extension Attributes.
jamf_list_computer_extension_attributes_data_dependencyFreeRead-onlyGet smart group/advance search dependent objects for a specified computer extension attribute.
jamf_list_computer_extension_attributes_downloadFreeRead-onlyDownload the specified Computer Extension Attribute.
jamf_list_computer_extension_attributes_historyFreeRead-onlyGet specified Computer Extension Attribute History object.
jamf_list_computer_extension_attributes_templatesFreeRead-onlyRetrieve All Computer Extension Attributes Templates.
jamf_update_computer_extension_attributesProDestructiveUpdate specified Computer Extension Attribute object.
jamf_upload_computer_extension_attributesProDestructiveUpload Computer Extension Attribute.

[Jamf Pro] Create Computer Extension Attribute. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Add specified Computer Extension Attribute history object notes. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesInstance ID of Computer Extension Attribute history

[Jamf Pro] Remove specified Computer Extension Attribute. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesUnique ID of Computer Extension Attribute.

[Jamf Pro] Delete multiple Computer Extension Attribute at once. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
ParamTypeRequiredDefaultDescription
idstringyesUnique ID of Computer Extension Attribute.
ParamTypeRequiredDefaultDescription
idstringyesUnique Id of the Template.

[Jamf Pro] Retrieve Computer Extension Attributes. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullFilters results. Use RSQL format for query. Allows for many fields, including ID, name, etc.<br/> Can be combined with paging and sorting.<br/> Fields allowed in the query: id, name <br/> Default filter is an empty query and returns all results from the requested page.
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorts results by one or more criteria, following the format property:asc/desc.<br/> Default sort is name:asc.<br/> If using multiple criteria, separate with commas. Allows sort for id and name.
ParamTypeRequiredDefaultDescription
idstringyesUnique ID of computer extension attribute.
ParamTypeRequiredDefaultDescription
idstringyesThe unique ID of the Computer Extension Attribute to be downloaded.

[Jamf Pro] Get specified Computer Extension Attribute History object. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullFilters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.
idstringyesInstance ID of Computer Extension Attribute history
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.

[Jamf Pro] Retrieve All Computer Extension Attributes Templates. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullFilters results. Use RSQL format for queries. which allows filtering by multiple fields such as templateName, templateCategoryName.<br/> Can be combined with paging and sorting.<br/> Fields allowed in the query: templateName, templateCategoryName <br/> Default filter is an empty query and returns all results from the requested page.
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorts results by one or more criteria, following the format property:asc/desc.<br/> Default sort is templateName:asc.<br/> If using multiple criteria, separate with commas. Allows sort for templateName and templateCategory.

[Jamf Pro] Update specified Computer Extension Attribute object. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesUnique ID of Computer Extension Attribute.

[Jamf Pro] Upload Computer Extension Attribute. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Computer Extension Attributes (Classic API)

ToolPlanAccessSummary
jamf_classic_create_computerextensionattributes_idProWriteCreates a new computer extension attribute by ID.
jamf_classic_delete_computerextensionattributes_idProDestructiveDeletes a computer extension attribute by ID.
jamf_classic_delete_computerextensionattributes_nameProDestructiveDeletes a computer extension attribute by name.
jamf_classic_get_computerextensionattributes_idFreeRead-onlyFinds computer extension attributes by ID.
jamf_classic_get_computerextensionattributes_nameFreeRead-onlyFinds computer extension attributes by name.
jamf_classic_list_computerextensionattributesFreeRead-onlyFinds all computer extension attributes.
jamf_classic_update_computerextensionattributes_idProDestructiveUpdates an existing computer extension attribute by ID.
jamf_classic_update_computerextensionattributes_nameProDestructiveUpdates an existing computer extension attribute by name.

[Jamf Pro] Creates a new computer extension attribute by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a computer extension attribute by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a computer extension attribute by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds computer extension attributes by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds computer extension attributes by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all computer extension attributes. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing computer extension attribute by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing computer extension attribute by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Computer Groups

ToolPlanAccessSummary
jamf_create_computer_groups_smart_groupsProWriteCreate a Smart Computer Group.
jamf_create_computer_groups_static_groupsProWriteCreate membership of a static computer group.
jamf_delete_computer_groups_smart_groupsProDestructiveRemove specified Smart Computer Group.
jamf_delete_computer_groups_static_groupsProDestructiveRemove Static Computer Group by Id.
jamf_get_computer_groups_smart_group_membershipFreeRead-onlyGet the membership of a Smart Computer Group.
jamf_get_computer_groups_smart_groupsFreeRead-onlyGet Smart Computer Group by Id.
jamf_get_computer_groups_static_groupsFreeRead-onlyGet Static Computer Group by Id.
jamf_list_computer_groupsFreeRead-onlyReturns the list of all computer groups.
jamf_list_computer_groups_smart_groupsFreeRead-onlySearch for Smart Computer Groups.
jamf_list_computer_groups_static_groupsFreeRead-onlySearch for Static Computer Groups.
jamf_update_computer_groups_smart_groupsProDestructiveUpdate a Smart Computer Group.
jamf_update_computer_groups_static_groupsProDestructiveUpdate membership of a static computer group.

[Jamf Pro] Create a Smart Computer Group. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
platformbooleannonullOptional. Return platform identifiers instead of internal identifiers when set to true.

[Jamf Pro] Create membership of a static computer group. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
platformbooleannonullOptional. Return platform identifiers instead of internal identifiers when set to true.

[Jamf Pro] Remove specified Smart Computer Group. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesid of target Smart Computer Group

[Jamf Pro] Remove Static Computer Group by Id. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of static computer group
ParamTypeRequiredDefaultDescription
idstringyesid of the Smart Computer Group
ParamTypeRequiredDefaultDescription
idstringyesinstance id of smart computer group
ParamTypeRequiredDefaultDescription
idstringyesinstance id of static computer group

[Jamf Pro] Search for Smart Computer Groups. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter smart computer group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. Example: name=="group"
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=name:asc

[Jamf Pro] Search for Static Computer Groups. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter static computer group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. Example: name=="group"
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=name:asc

[Jamf Pro] Update a Smart Computer Group. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesid of target Smart Computer Group

[Jamf Pro] Update membership of a static computer group. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of a static computer group

Computer Groups (Classic API)

ToolPlanAccessSummary
jamf_classic_create_computergroups_idProWriteCreates a new computer group by ID.
jamf_classic_delete_computergroups_idProDestructiveDeletes a computer group by ID.
jamf_classic_delete_computergroups_nameProDestructiveDeletes a computer group by name.
jamf_classic_get_computergroups_idFreeRead-onlyFinds computer groups by ID.
jamf_classic_get_computergroups_nameFreeRead-onlyFinds computer groups by name.
jamf_classic_list_computergroupsFreeRead-onlyFinds all computer groups.
jamf_classic_update_computergroups_idProDestructiveUpdates an existing computer group by ID.
jamf_classic_update_computergroups_nameProDestructiveUpdates an existing computer group by name.

[Jamf Pro] Creates a new computer group by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a computer group by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a computer group by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds computer groups by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds computer groups by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all computer groups. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing computer group by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing computer group by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Computer Hardware and Software Reports (Classic API)

ToolPlanAccessSummary
jamf_classic_get_computerhardwaresoftwarereports_idFreeRead-onlyFinds hardware/software reports by computer ID.
jamf_classic_get_computerhardwaresoftwarereports_id_subsetFreeRead-onlyFinds a subset of hardware/software reports by computer ID.
jamf_classic_get_computerhardwaresoftwarereports_macaddressFreeRead-onlyFinds hardware/software reports by computer MAC address.
jamf_classic_get_computerhardwaresoftwarereports_nameFreeRead-onlyFinds hardware/software reports by computer name.
jamf_classic_get_computerhardwaresoftwarereports_name_subsetFreeRead-onlyFinds a subset of hardware/software reports by computer name.
jamf_classic_get_computerhardwaresoftwarereports_serialnumberFreeRead-onlyFinds hardware/software reports by computer serial number.
jamf_classic_get_computerhardwaresoftwarereports_udidFreeRead-onlyFinds hardware/software reports by computer UDID.
jamf_classic_get_computerhardwaresoftwarereports_udid_subsetFreeRead-onlyFinds a subset of hardware/software reports by computer UDID.
jamf_classic_get_computerhwswreports_macaddress_subsetFreeRead-onlyFinds a subset of hardware/software reports by computer MAC address.
jamf_classic_get_computerhwswreports_serialnumber_subsetFreeRead-onlyFinds a subset of hardware/software reports by computer serial number.

[Jamf Pro] Finds hardware/software reports by computer ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
idstringyesID value to filter by
startDatestringyesStart date (e.g. yyyy-mm-dd)

[Jamf Pro] Finds a subset of hardware/software reports by computer ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
idstringyesComputer ID to filter by
startDatestringyesStart date (e.g. yyyy-mm-dd)
subsetstringyesSubset to filter by

[Jamf Pro] Finds hardware/software reports by computer MAC address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
macaddressstringyesMAC address to filter by
startDatestringyesStart date (e.g. yyyy-mm-dd)

[Jamf Pro] Finds hardware/software reports by computer name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
namestringyesName to filter by
startDatestringyesStart date (e.g. yyyy-mm-dd)

[Jamf Pro] Finds a subset of hardware/software reports by computer name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
namestringyesName to filter by
startDatestringyesStart date (e.g. yyyy-mm-dd)
subsetstringyesSubset to filter by

[Jamf Pro] Finds hardware/software reports by computer serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
serialnumberstringyesSerial number to filter by
startDatestringyesStart date (e.g. yyyy-mm-dd)

[Jamf Pro] Finds hardware/software reports by computer UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
startDatestringyesStart date (e.g. yyyy-mm-dd)
udidstringyesUDID to filter by

[Jamf Pro] Finds a subset of hardware/software reports by computer UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
startDatestringyesStart date (e.g. yyyy-mm-dd)
subsetstringyesSubset to filter by
udidstringyesUDID to filter by

[Jamf Pro] Finds a subset of hardware/software reports by computer MAC address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
macaddressstringyesMAC address to filter by
startDatestringyesStart date (e.g. yyyy-mm-dd)
subsetstringyesSubset to filter by

[Jamf Pro] Finds a subset of hardware/software reports by computer serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date (e.g. yyyy-mm-dd)
serialnumberstringyesSerial number to filter by
startDatestringyesStart date (e.g. yyyy-mm-dd)
subsetstringyesSubset to filter by

Computer History (Classic API)

ToolPlanAccessSummary
jamf_classic_get_computerhistory_idFreeRead-onlyFinds computer history by ID.
jamf_classic_get_computerhistory_id_subsetFreeRead-onlyFinds a subset of computer history data by ID.
jamf_classic_get_computerhistory_macaddressFreeRead-onlyFinds computer history by MAC address.
jamf_classic_get_computerhistory_macaddress_subsetFreeRead-onlyFinds a subset of computer history data by MAC address.
jamf_classic_get_computerhistory_nameFreeRead-onlyFinds computer history by name.
jamf_classic_get_computerhistory_name_subsetFreeRead-onlyFinds a subset of computer history data by name.
jamf_classic_get_computerhistory_serialnumberFreeRead-onlyFinds computer history by serial number.
jamf_classic_get_computerhistory_serialnumber_subsetFreeRead-onlyFinds a subset of computer history data by serial number.
jamf_classic_get_computerhistory_udidFreeRead-onlyFinds computer history by UDID.
jamf_classic_get_computerhistory_udid_subsetFreeRead-onlyFinds a subset of computer history data by UDID.

[Jamf Pro] Finds computer history by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesComputer ID value to filter by

[Jamf Pro] Finds a subset of computer history data by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesComputer ID to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds computer history by MAC address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
macaddressstringyesComputer Mac Address to filter by

[Jamf Pro] Finds a subset of computer history data by MAC address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
macaddressstringyesComputer Mac Address to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds computer history by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesComputer Name to filter by

[Jamf Pro] Finds a subset of computer history data by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesComputer Name to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds computer history by serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
serialnumberstringyesComputer Serial Number to filter by

[Jamf Pro] Finds a subset of computer history data by serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
serialnumberstringyesComputer Serial Number to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds computer history by UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
udidstringyesComputer UDID to filter by

[Jamf Pro] Finds a subset of computer history data by UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
subsetstringyesSubset to filter by
udidstringyesComputer UDID to filter by

Computer Inventory

ToolPlanAccessSummary
jamf_create_computer_inventory_remove_mdm_profileProDestructiveRemove a computer's MDM profile.
jamf_erase_computer_inventoryProDestructiveErase a computer.

[Jamf Pro] Remove a computer's MDM profile. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
idstringyesId of the computer to remove the MDM profile from

[Jamf Pro] Erase a computer. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE AND IRREVERSIBLE: this sends the Apple MDM EraseDevice command, which returns the Mac to factory settings. Anything not already backed up is lost, and Jamf Pro cannot undo it. Confirm the computer identity with jamf_get_computers_inventory first. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesId of the computer to erase

Computer Inventory Collection (Classic API)

ToolPlanAccessSummary
jamf_classic_list_computerinventorycollectionFreeRead-onlyFinds the Jamf Pro computer inventory collection information.
jamf_classic_update_computerinventorycollectionProDestructiveUpdates the Jamf Pro computer inventory collection information.

[Jamf Pro] Finds the Jamf Pro computer inventory collection information. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates the Jamf Pro computer inventory collection information. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.

Computer Inventory Collection Settings

ToolPlanAccessSummary
jamf_custom_path_computer_inventory_collection_settingsProWriteCreate Computer Inventory Collection Settings Custom Path.
jamf_delete_computer_inventory_collection_settings_custom_pathProDestructiveDelete Custom Path from Computer Inventory Collection Settings.
jamf_list_computer_inventory_collection_settingsFreeRead-onlyReturns computer inventory settings.
jamf_patch_computer_inventory_collection_settingsProWriteUpdate computer inventory settings.

[Jamf Pro] Create Computer Inventory Collection Settings Custom Path. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete Custom Path from Computer Inventory Collection Settings. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesid of Custom Path

[Jamf Pro] Update computer inventory settings. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Computer Invitations (Classic API)

ToolPlanAccessSummary
jamf_classic_create_computerinvitations_idProDestructiveCreates a new computer invitation by id.
jamf_classic_create_computerinvitations_invitationProDestructiveCreates a new computer invitation by invitation.
jamf_classic_delete_computerinvitations_idProDestructiveDeletes a computer invitation by id.
jamf_classic_delete_computerinvitations_invitationProDestructiveDeletes a computer invitation by invitation.
jamf_classic_get_computerinvitations_idFreeRead-onlyFinds computer invitations by id.
jamf_classic_get_computerinvitations_invitationFreeRead-onlyFinds computer invitations by invitation.
jamf_classic_list_computerinvitationsFreeRead-onlyFinds all computer invitations.

[Jamf Pro] Creates a new computer invitation by id. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Creates a new computer invitation by invitation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
invitationstringyesInvitation value to filter by

[Jamf Pro] Deletes a computer invitation by id. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a computer invitation by invitation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
invitationstringyesInvitation value to filter by

[Jamf Pro] Finds computer invitations by id. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds computer invitations by invitation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
invitationstringyesInvitation value to filter by

[Jamf Pro] Finds all computer invitations. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

Computer Management (Classic API)

ToolPlanAccessSummary
jamf_classic_get_computermanagement_idFreeRead-onlyFinds computer management information by ID.
jamf_classic_get_computermanagement_id_patchfilterFreeRead-onlyDisplay patch management information for a computer and filter.
jamf_classic_get_computermanagement_id_subsetFreeRead-onlyFinds a subset of computer management information by ID.
jamf_classic_get_computermanagement_id_usernameFreeRead-onlyFinds management information for a computer and username.
jamf_classic_get_computermanagement_id_username_subsetFreeRead-onlyFinds a subset of management information for a computer and username.
jamf_classic_get_computermanagement_macaddressFreeRead-onlyFinds computer management information by MAC address.
jamf_classic_get_computermanagement_macaddress_patchfilterFreeRead-onlyDisplay patch management information for a computer and filter.
jamf_classic_get_computermanagement_macaddress_subsetFreeRead-onlyFinds a subset of computer management information by MAC address.
jamf_classic_get_computermanagement_macaddress_usernameFreeRead-onlyFinds management information for a computer and username.
jamf_classic_get_computermanagement_macaddress_username_subsetFreeRead-onlyFinds a subset of management information for a computer and username.
jamf_classic_get_computermanagement_nameFreeRead-onlyFinds computer management information by name.
jamf_classic_get_computermanagement_name_patchfilterFreeRead-onlyDisplay patch management information for a computer and filter.
jamf_classic_get_computermanagement_name_subsetFreeRead-onlyFinds a subset of computer management information by name.
jamf_classic_get_computermanagement_name_usernameFreeRead-onlyFinds management information for a computer and username.
jamf_classic_get_computermanagement_name_username_subsetFreeRead-onlyFinds a subset of management information for a computer and username.
jamf_classic_get_computermanagement_serialnumberFreeRead-onlyFinds computer management information by serial number.
jamf_classic_get_computermanagement_serialnumber_patchfilterFreeRead-onlyDisplay patch management information for a computer and filter.
jamf_classic_get_computermanagement_serialnumber_subsetFreeRead-onlyFinds a subset of computer management information by serial number.
jamf_classic_get_computermanagement_serialnumber_usernameFreeRead-onlyFinds management information for a computer and username.
jamf_classic_get_computermanagement_serialnumber_username_subsetFreeRead-onlyFinds a subset of management information for a computer and username.
jamf_classic_get_computermanagement_udidFreeRead-onlyFinds computer management information by UDID.
jamf_classic_get_computermanagement_udid_patchfilterFreeRead-onlyDisplay patch management information for a computer and filter.
jamf_classic_get_computermanagement_udid_subsetFreeRead-onlyFinds a subset of computer management information by UDID.
jamf_classic_get_computermanagement_udid_usernameFreeRead-onlyFinds management information for a computer and username.
jamf_classic_get_computermanagement_udid_username_subsetFreeRead-onlyFinds a subset of management information for a computer and username.

[Jamf Pro] Finds computer management information by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesComputer ID value to filter by

[Jamf Pro] Display patch management information for a computer and filter. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringyesfilter to apply
idstringyesComputer ID to filter by

[Jamf Pro] Finds a subset of computer management information by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesComputer ID value to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds management information for a computer and username. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesComputer ID to filter by
usernamestringyesUsername to filter by

[Jamf Pro] Finds a subset of management information for a computer and username. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesComputer ID to filter by
subsetstringyesSubset to filter by
usernamestringyesUsername to filter by

[Jamf Pro] Finds computer management information by MAC address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
macaddressstringyesComputer Mac Address to filter by

[Jamf Pro] Display patch management information for a computer and filter. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringyesfilter to apply
macaddressstringyesComputer Mac address to filter by

[Jamf Pro] Finds a subset of computer management information by MAC address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
macaddressstringyesComputer Mac Address to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds management information for a computer and username. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
macaddressstringyesComputer Mac address to filter by
usernamestringyesUsername to filter by

[Jamf Pro] Finds a subset of management information for a computer and username. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
macaddressstringyesComputer Mac Address to filter by
subsetstringyesSubset to filter by
usernamestringyesUsername to filter by

[Jamf Pro] Finds computer management information by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesComputer Name to filter by

[Jamf Pro] Display patch management information for a computer and filter. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringyesfilter to apply
namestringyesComputer name to filter by

[Jamf Pro] Finds a subset of computer management information by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesComputer Name to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds management information for a computer and username. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesComputer name to filter by
usernamestringyesUsername to filter by

[Jamf Pro] Finds a subset of management information for a computer and username. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesComputer name to filter by
subsetstringyesSubset to filter by
usernamestringyesUsername to filter by

[Jamf Pro] Finds computer management information by serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
serialnumberstringyesComputer Serial Number to filter by

[Jamf Pro] Display patch management information for a computer and filter. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringyesfilter to apply
serialnumberstringyesComputer serial number to filter by

[Jamf Pro] Finds a subset of computer management information by serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
serialnumberstringyesComputer Serial Number to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds management information for a computer and username. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
serialnumberstringyesComputer serial number to filter by
usernamestringyesUsername to filter by

[Jamf Pro] Finds a subset of management information for a computer and username. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
serialnumberstringyesComputer serial number to filter by
subsetstringyesSubset to filter by
usernamestringyesUsername to filter by

[Jamf Pro] Finds computer management information by UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
udidstringyesComputer UDID to filter by

[Jamf Pro] Display patch management information for a computer and filter. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringyesfilter to apply
udidstringyesComputer UDID to filter by

[Jamf Pro] Finds a subset of computer management information by UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
subsetstringyesSubset to filter by
udidstringyesComputer UDID to filter by

[Jamf Pro] Finds management information for a computer and username. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
udidstringyesComputer UDID to filter by
usernamestringyesUsername to filter by

[Jamf Pro] Finds a subset of management information for a computer and username. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
subsetstringyesSubset to filter by
udidstringyesComputer UDID to filter by
usernamestringyesUsername to filter by

Computer Prestages

ToolPlanAccessSummary
jamf_create_computer_prestagesProWriteCreate a Computer Prestage.
jamf_create_computer_prestages_scopeProWriteAdd device Scope for a specific Computer Prestage.
jamf_delete_computer_prestagesProDestructiveDelete a Computer Prestage with the supplied id.
jamf_delete_multiple_computer_prestages_scopeProDestructiveRemove device Scope for a specific Computer Prestage.
jamf_get_computer_prestagesFreeRead-onlyRetrieve a Computer Prestage with the supplied id.
jamf_list_computer_prestagesFreeRead-onlyGet sorted and paged Computer Prestages.
jamf_list_computer_prestages_scopeFreeRead-onlyGet all device Scope for all Computer Prestages.
jamf_list_computer_prestages_scope_idFreeRead-onlyGet device Scope for a specific Computer Prestage.
jamf_update_computer_prestagesProDestructiveUpdate a Computer Prestage.
jamf_update_computer_prestages_scopeProDestructiveReplace device Scope for a specific Computer Prestage.

[Jamf Pro] Create a Computer Prestage. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Add device Scope for a specific Computer Prestage. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesComputer Prestage identifier

[Jamf Pro] Delete a Computer Prestage with the supplied id. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesComputer Prestage identifier

[Jamf Pro] Remove device Scope for a specific Computer Prestage. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesComputer Prestage identifier
ParamTypeRequiredDefaultDescription
idstringyesComputer Prestage identifier

[Jamf Pro] Get sorted and paged Computer Prestages. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc
ParamTypeRequiredDefaultDescription
idstringyesComputer Prestage identifier

[Jamf Pro] Update a Computer Prestage. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesComputer Prestage identifier

[Jamf Pro] Replace device Scope for a specific Computer Prestage. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesComputer Prestage identifier

Computer Reports (Classic API)

ToolPlanAccessSummary
jamf_classic_get_computerreports_idFreeRead-onlyFinds computer reports by id.
jamf_classic_get_computerreports_nameFreeRead-onlyFinds computer reports by name.
jamf_classic_list_computerreportsFreeRead-onlyFinds all computer reports.

[Jamf Pro] Finds computer reports by id. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesComputer Report ID to filter by

[Jamf Pro] Finds computer reports by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesComputer Report name to filter by

[Jamf Pro] Finds all computer reports. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

Computers

ToolPlanAccessSummary
jamf_create_computers_recalculate_smart_groupsProWriteRecalculate a smart group for the given id.
ParamTypeRequiredDefaultDescription
idstringyesid of computer

Computers (Classic API)

ToolPlanAccessSummary
jamf_classic_create_computers_idProWriteCreates a computer.
jamf_classic_delete_computers_idProDestructiveDeletes a computer by ID.
jamf_classic_delete_computers_macaddressProDestructiveDeletes a computer by MAC address.
jamf_classic_delete_computers_nameProDestructiveDeletes a computer by name.
jamf_classic_delete_computers_serialnumberProDestructiveDeletes a computer by serial number.
jamf_classic_delete_computers_udidProDestructiveDeletes a computer by UDID.
jamf_classic_get_computers_idFreeRead-onlyFinds computers by ID.
jamf_classic_get_computers_id_subsetFreeRead-onlyFinds a subset of information for a computer.
jamf_classic_get_computers_macaddressFreeRead-onlyFinds computers by MAC address.
jamf_classic_get_computers_macaddress_subsetFreeRead-onlyFinds a subset of data for computers by MAC address.
jamf_classic_get_computers_matchFreeRead-onlySearches for computers that match the provided parameter.
jamf_classic_get_computers_match_nameFreeRead-onlySearches for computers that match the provided name parameter.
jamf_classic_get_computers_nameFreeRead-onlyFinds the first computer with the given name.
jamf_classic_get_computers_name_subsetFreeRead-onlyFinds a subset of data for the first computer with the given name.
jamf_classic_get_computers_serialnumberFreeRead-onlyFinds computers by serial number.
jamf_classic_get_computers_serialnumber_subsetFreeRead-onlyFinds a subset of data for computers by serial number.
jamf_classic_get_computers_udidFreeRead-onlyFinds computers by UDID.
jamf_classic_get_computers_udid_subsetFreeRead-onlyFinds a subset of data for computers by UDID.
jamf_classic_list_computersFreeRead-onlyFinds all computers.
jamf_classic_list_computers_subset_basicFreeRead-onlyFinds basic information for all computers.
jamf_classic_update_computers_idProDestructiveUpdates an existing computer by ID.
jamf_classic_update_computers_macaddressProDestructiveUpdates an existing computer by MAC address.
jamf_classic_update_computers_nameProDestructiveUpdates an existing computer by name.
jamf_classic_update_computers_serialnumberProDestructiveUpdates an existing computer by serial number.
jamf_classic_update_computers_udidProDestructiveUpdates an existing computer by UDID.

[Jamf Pro] Creates a computer. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a computer by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a computer by MAC address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
macaddressstringyesMAC address value to filter by

[Jamf Pro] Deletes a computer by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Deletes a computer by serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
serialnumberstringyesSerial number value to filter by

[Jamf Pro] Deletes a computer by UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
udidstringyesUDID value to filter by

[Jamf Pro] Finds computers by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds a subset of information for a computer. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
idstringyesID to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds computers by MAC address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
macaddressstringyesMac address to filter by

[Jamf Pro] Finds a subset of data for computers by MAC address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
macaddressstringyesMac address to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Searches for computers that match the provided parameter. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
matchstringyesName, mac address, etc. to filter by. Match uses the same format as the general search in Jamf Pro. For instance, admin* can be used to match computer names that begin with admin

[Jamf Pro] Searches for computers that match the provided name parameter. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
matchnamestringyesName to filter by

[Jamf Pro] Finds the first computer with the given name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds a subset of data for the first computer with the given name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds computers by serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
serialnumberstringyesSerial number to filter by

[Jamf Pro] Finds a subset of data for computers by serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
serialnumberstringyesSerial number to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds computers by UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
udidstringyesUDID to filter by

[Jamf Pro] Finds a subset of data for computers by UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
subsetstringyesSubset to filter by
udidstringyesUDID to filter by

[Jamf Pro] Finds all computers. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

[Jamf Pro] Finds basic information for all computers. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

[Jamf Pro] Updates an existing computer by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing computer by MAC address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
macaddressstringyesMAC address value to filter by

[Jamf Pro] Updates an existing computer by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

[Jamf Pro] Updates an existing computer by serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
serialnumberstringyesSerial number value to filter by

[Jamf Pro] Updates an existing computer by UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
udidstringyesUDID value to filter by

Computers Inventory

ToolPlanAccessSummary
jamf_create_computers_inventoryProWriteCreate Computer Inventory record.
jamf_create_computers_inventory_attachmentsProDestructiveUpload attachment and assign to computer.
jamf_create_computers_inventory_remove_mdm_profileProDestructiveRemove a computer's MDM profile.
jamf_delete_computers_inventoryProDestructiveRemove specified Computer record.
jamf_delete_computers_inventory_attachmentsProDestructiveRemove attachment.
jamf_erase_computers_inventoryProDestructiveErase a computer.
jamf_get_computers_inventoryFreeRead-onlyReturn General section of a Computer.
jamf_get_computers_inventory_attachmentsFreeRead-onlyDownload attachment file.
jamf_list_computers_inventoryFreeRead-onlyReturn paginated Computer Inventory records.
jamf_list_computers_inventory_filevaultFreeRead-onlyReturn paginated FileVault information for all computers.
jamf_list_computers_inventory_filevault_idFreeRead-onlyReturn FileVault information for a specific computer.
jamf_list_computers_inventory_view_device_lock_pinFreeRead-onlyReturn a computer's Device Lock PIN.
jamf_list_computers_inventory_view_recovery_lock_passwordFreeRead-onlyReturn a Computers Recovery Lock Password.

[Jamf Pro] Create Computer Inventory record. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Upload attachment and assign to computer. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of computer record

[Jamf Pro] Remove a computer's MDM profile. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesId of the computer to remove the MDM profile from

[Jamf Pro] Remove specified Computer record. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of computer record

[Jamf Pro] Remove attachment. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
attachmentIdstringyesinstance id of attachment object
idstringyesinstance id of computer record

[Jamf Pro] Erase a computer. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE AND IRREVERSIBLE: this sends the Apple MDM EraseDevice command, which returns the Mac to factory settings. Anything not already backed up is lost, and Jamf Pro cannot undo it. Confirm the computer identity with jamf_get_computers_inventory first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesId of the computer to erase
ParamTypeRequiredDefaultDescription
idstringyesinstance id of computer record
sectionstringnonullsection of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=general&section=hardware
ParamTypeRequiredDefaultDescription
attachmentIdstringyesinstance id of attachment object
idstringyesinstance id of computer record

[Jamf Pro] Return paginated Computer Inventory records. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter computer inventory collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: `general.name`, `udid`, `id`, `general.assetTag`, `general.barcode1`, `general.barcode2`, `general.enrolledViaAutomatedDeviceEnrollment`, `general.lastIpAddress`, `general.itunesStoreAccountActive`, `general.jamfBinaryVersion`, `general.lastCheckIn`, `general.lastContact`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`, `general.reportDate`, `general.lastReportedIp`, `general.lastReportedIpV4`, `general.lastReportedIpV6`, `general.managementId`, `general.remoteManagement.managed`, `general.mdmCapable.capable`, `general.mdmCertificateExpiration`, `general.platform`, `general.supervised`, `general.userApprovedMdm`, `general.declarativeDeviceManagementEnabled`, `general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`, `general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`, `general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`, `hardware.bleCapable`, `hardware.macAddress`, `hardware.make`, `hardware.model`, `hardware.modelIdentifier`, `hardware.serialNumber`, `hardware.supportsIosAppInstalls`,`hardware.appleSilicon`, `operatingSystem.activeDirectoryStatus`, `operatingSystem.fileVault2Status`, `operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`, `security.activationLockEnabled`, `security.recoveryLockEnabled`,`security.firewallEnabled`,`userAndLocation.buildingId`, `userAndLocation.departmentId`, `userAndLocation.email`, `userAndLocation.realname`, `userAndLocation.phone`, `userAndLocation.position`,`userAndLocation.room`, `userAndLocation.username`, `diskEncryption.fileVault2Enabled`, `purchasing.appleCareId`, `purchasing.lifeExpectancy`, `purchasing.purchased`, `purchasing.leased`, `purchasing.vendor`, `purchasing.warrantyDate`, This param can be combined with paging and sorting. Example: `filter=general.name=="Orchard"`
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sectionstringnonullsection of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&section=HARDWARE
sortstringnonullSorting criteria in the format: `property:asc/desc`. Default sort is `general.name:asc`. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the sort: `general.name`, `udid`, `id`, `general.assetTag`, `general.jamfBinaryVersion`, `general.lastCheckIn`, `general.lastContact`, `general.lastEnrolledDate`, `general.lastCloudBackupDate`, `general.reportDate`, `general.mdmCertificateExpiration`, `general.platform`, `general.lastLoggedInUsernameSelfService`, `general.lastLoggedInUsernameSelfServiceTimestamp`, `general.lastLoggedInUsernameBinary`, `general.lastLoggedInUsernameBinaryTimestamp`, `general.lastLoggedInUsernameMdm`, `general.lastLoggedInUsernameMdmTimestamp`, `hardware.make`, `hardware.model`, `operatingSystem.build`, `operatingSystem.supplementalBuildVersion`, `operatingSystem.rapidSecurityResponse`, `operatingSystem.name`, `operatingSystem.version`, `userAndLocation.realname`, `purchasing.lifeExpectancy`, `purchasing.warrantyDate` Example: `sort=udid:desc,general.name:asc`.

[Jamf Pro] Return paginated FileVault information for all computers. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
ParamTypeRequiredDefaultDescription
idstringyesinstance id of computer record
ParamTypeRequiredDefaultDescription
idstringyesinstance id of computer record
ParamTypeRequiredDefaultDescription
idstringyesinstance id of computer record

Computers Inventory Detail

ToolPlanAccessSummary
jamf_get_computers_inventory_detailFreeRead-onlyReturn all sections of a computer.
jamf_patch_computers_inventory_detailProWriteUpdate specific fields on a computer.
ParamTypeRequiredDefaultDescription
idstringyesinstance id of computer record

[Jamf Pro] Update specific fields on a computer. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of computer record

Local Administrator Password (LAPS)

ToolPlanAccessSummary
jamf_list_local_admin_password_account_auditFreeRead-onlyGet LAPS password viewed history.
jamf_list_local_admin_password_account_audit_guidFreeRead-onlyGet LAPS password viewed history.
jamf_list_local_admin_password_account_historyFreeRead-onlyGet LAPS historical records for target device and username.
jamf_list_local_admin_password_account_history_guidFreeRead-onlyGet LAPS historical records for target device and user guid.
jamf_list_local_admin_password_account_passwordFreeRead-onlyGet current LAPS password for specified username on a client.
jamf_list_local_admin_password_account_password_guidFreeRead-onlyGet current LAPS password for specified user guid on a client.
jamf_list_local_admin_password_accountsFreeRead-onlyGet the LAPS capable admin accounts for a device.
jamf_list_local_admin_password_historyFreeRead-onlyGet LAPS password viewed history, and rotation history.
jamf_list_local_admin_password_pending_rotationsFreeRead-onlyGet a list of the current devices and usernames with pending LAPS rotations.
jamf_list_local_admin_password_settingsFreeRead-onlyGet the current LAPS settings.
jamf_update_local_admin_password_set_passwordProDestructiveSet the LAPS password for a device.
jamf_update_local_admin_password_settingsProDestructiveUpdate settings for LAPS.
ParamTypeRequiredDefaultDescription
clientManagementIdstringyesclient management id of target device.
usernamestringyesuser name to view audit information for
ParamTypeRequiredDefaultDescription
clientManagementIdstringyesclient management id of target device.
guidstringyesuser guid to view audit information for
usernamestringyesuser name to view audit information for
ParamTypeRequiredDefaultDescription
clientManagementIdstringyesclient management id of target device.
usernamestringyesuser name to view history for
ParamTypeRequiredDefaultDescription
clientManagementIdstringyesclient management id of target device.
guidstringyesuser guid to view history for
usernamestringyesuser name to view history for
ParamTypeRequiredDefaultDescription
clientManagementIdstringyesclient management id of target device.
usernamestringyesuser name for the account
ParamTypeRequiredDefaultDescription
clientManagementIdstringyesclient management id of target device.
guidstringyesuser guid for the account
usernamestringyesuser name for the account
ParamTypeRequiredDefaultDescription
clientManagementIdstringyesclient management id of target device.
ParamTypeRequiredDefaultDescription
clientManagementIdstringyesclient management id of target device.

[Jamf Pro] Set the LAPS password for a device. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
clientManagementIdstringyesclient management id of target device.
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Update settings for LAPS. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Smart Computer Groups

ToolPlanAccessSummary
jamf_create_smart_computer_groups_recalculateProWriteRecalculate the smart group for the given id.
ParamTypeRequiredDefaultDescription
idstringyesinstance id of smart group

Advanced Mobile Device Searches

ToolPlanAccessSummary
jamf_create_advanced_mobile_device_searchesProWriteCreate Advanced Search object.
jamf_delete_advanced_mobile_device_searchesProDestructiveRemove specified Advanced Search object.
jamf_delete_multiple_advanced_mobile_device_searchesProDestructiveRemove specified Advanced Search objects.
jamf_get_advanced_mobile_device_searchesFreeRead-onlyGet specified Advanced Search object.
jamf_list_advanced_mobile_device_searchesFreeRead-onlyGet Advanced Search objects.
jamf_list_advanced_mobile_device_searches_choicesFreeRead-onlyGet Mobile Device Advanced Search criteria choices.
jamf_update_advanced_mobile_device_searchesProDestructiveGet specified Advanced Search object.

[Jamf Pro] Create Advanced Search object. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Remove specified Advanced Search object. DESTRUCTIVE: this deletes the saved advanced mobile device search. The criteria are lost, and anything that referenced the search by ID stops resolving.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of advanced search record

[Jamf Pro] Remove specified Advanced Search objects. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE, AND IT FANS OUT: the body carries a list of IDs and every search in it is deleted in one call. Check the list against jamf_list_advanced_mobile_device_searches before you send it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
ParamTypeRequiredDefaultDescription
idstringyesid of target Advanced Search

[Jamf Pro] Get Advanced Search objects. Saved advanced mobile device searches on the Jamf Pro API. The criteria fields available to a search are listed by jamf_list_advanced_mobile_device_searches_choices.

ParamTypeRequiredDefaultDescription
containsstringnonullReturns only the choices that contain this text.
criteriastringyesThe advanced-search criterion whose choices to list, for example "App Name", "Building" or "Display Name".
sitestringnonullThe id of the site to scope the choices to. The vendor default is -1, which means every site.

[Jamf Pro] Get specified Advanced Search object. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE BECAUSE THIS PUT REPLACES THE WHOLE OBJECT: send every field. An omitted criteria list is cleared rather than left alone, so read the search with jamf_get_advanced_mobile_device_searches first and edit what it returns.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesid of target Advanced Search

Advanced Mobile Device Searches (Classic API)

ToolPlanAccessSummary
jamf_classic_create_advancedmobiledevicesearches_idProWriteCreates a new advanced mobile device search.
jamf_classic_delete_advancedmobiledevicesearches_idProDestructiveDeletes a mobile device search by ID.
jamf_classic_delete_advancedmobiledevicesearches_nameProDestructiveDeletes a mobile device search by name.
jamf_classic_get_advancedmobiledevicesearches_idFreeRead-onlyFinds mobile device searches by ID.
jamf_classic_get_advancedmobiledevicesearches_nameFreeRead-onlyFinds advanced mobile device searches by name.
jamf_classic_list_advancedmobiledevicesearchesFreeRead-onlyFinds all advanced mobile device searches.
jamf_classic_update_advancedmobiledevicesearches_idProDestructiveUpdates an existing advanced mobile device search by ID.
jamf_classic_update_advancedmobiledevicesearches_nameProDestructiveUpdates an existing advanced mobile device search by name.

[Jamf Pro] Creates a new advanced mobile device search. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device search by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the saved advanced mobile device search. The criteria are lost, and anything that referenced the search by ID stops resolving.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device search by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the saved advanced mobile device search. The criteria are lost, and anything that referenced the search by ID stops resolving.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds mobile device searches by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds advanced mobile device searches by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all advanced mobile device searches. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Saved advanced mobile device searches. Each one is a stored set of criteria plus the fields it displays; fetch a single search by ID or name to get its criteria and its current results.

[Jamf Pro] Updates an existing advanced mobile device search by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. Any element you leave out is cleared on the saved search rather than left alone, so read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing advanced mobile device search by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. Any element you leave out is cleared on the saved search rather than left alone, so read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesNameto filter by

Devices

ToolPlanAccessSummary
jamf_list_devices_extensionattributesFreeRead-onlyGet Mobile Device Extension Attribute values placed in select paramter.
jamf_list_devices_groupsFreeRead-onlyReturn a list of groups for a device.

[Jamf Pro] Get Mobile Device Extension Attribute values placed in select paramter. The extension attribute definitions that apply across devices, rather than the values collected on any one device.

ParamTypeRequiredDefaultDescription
selectstringnonullAcceptable values currently include: * name

[Jamf Pro] Return a list of groups for a device. The groups one device belongs to. Takes the device id from jamf_list_mobile_devices.

ParamTypeRequiredDefaultDescription
idstringyesDevice Platform ID

Mobile Device Applications (Classic API)

ToolPlanAccessSummary
jamf_classic_create_mobiledeviceapplications_idProWriteCreates a new mobile device application by ID.
jamf_classic_delete_mobiledeviceapplications_bundleidProDestructiveDeletes a mobile device application by bundle ID.
jamf_classic_delete_mobiledeviceapplications_bundleid_versionProDestructiveDeletes a mobile device application by bundle ID and version.
jamf_classic_delete_mobiledeviceapplications_idProDestructiveDeletes a mobile device application by ID.
jamf_classic_delete_mobiledeviceapplications_nameProDestructiveDeletes a mobile device application by name.
jamf_classic_get_mobiledeviceapplications_bundleidFreeRead-onlyFinds mobile device applications by bundle ID.
jamf_classic_get_mobiledeviceapplications_bundleid_versionFreeRead-onlyFinds mobile device applications by bundle ID and version.
jamf_classic_get_mobiledeviceapplications_idFreeRead-onlyFinds mobile device applications by ID.
jamf_classic_get_mobiledeviceapplications_id_subsetFreeRead-onlyFinds a subset of data for a mobile device application by ID.
jamf_classic_get_mobiledeviceapplications_nameFreeRead-onlyFinds mobile device applications by name.
jamf_classic_get_mobiledeviceapplications_name_subsetFreeRead-onlyFinds a subset of data for mobile device applications by name.
jamf_classic_list_mobiledeviceapplicationsFreeRead-onlyFinds all mobile device applications.
jamf_classic_update_mobiledeviceapplications_bundleidProDestructiveUpdates an existing mobile device application by bundle ID.
jamf_classic_update_mobiledeviceapplications_bundleid_versionProDestructiveUpdates an existing mobile device application by bundle ID and version.
jamf_classic_update_mobiledeviceapplications_idProDestructiveUpdates an existing mobile device application by ID.
jamf_classic_update_mobiledeviceapplications_nameProDestructiveUpdates an existing mobile device application by name.

[Jamf Pro] Creates a new mobile device application by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device application by bundle ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the managed app record. Jamf Pro stops managing the app on every device in the old scope, and a managed app set to remove on unmanage is uninstalled from those devices.

ParamTypeRequiredDefaultDescription
bundleidstringyesBundle ID value to filter by

[Jamf Pro] Deletes a mobile device application by bundle ID and version. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the managed app record. Jamf Pro stops managing the app on every device in the old scope, and a managed app set to remove on unmanage is uninstalled from those devices.

ParamTypeRequiredDefaultDescription
bundleidstringyesBundle ID value to filter by
versionstringyesVersion to filter by

[Jamf Pro] Deletes a mobile device application by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the managed app record. Jamf Pro stops managing the app on every device in the old scope, and a managed app set to remove on unmanage is uninstalled from those devices.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device application by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the managed app record. Jamf Pro stops managing the app on every device in the old scope, and a managed app set to remove on unmanage is uninstalled from those devices.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds mobile device applications by bundle ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
bundleidstringyesBundle ID to filter by

[Jamf Pro] Finds mobile device applications by bundle ID and version. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
bundleidstringyesBundle ID to filter by
versionstringyesVersion to filter by

[Jamf Pro] Finds mobile device applications by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds a subset of data for a mobile device application by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds mobile device applications by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds a subset of data for mobile device applications by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds all mobile device applications. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. The managed mobile device apps Jamf Pro distributes, with their bundle identifiers and versions. A single app can be looked up by ID, by name, or by bundle identifier with or without a version.

[Jamf Pro] Updates an existing mobile device application by bundle ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. An omitted scope element empties the scope, which pulls the managed app from the devices that had it. Read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
bundleidstringyesBundle ID value to filter by

[Jamf Pro] Updates an existing mobile device application by bundle ID and version. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. An omitted scope element empties the scope, which pulls the managed app from the devices that had it. Read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
bundleidstringyesBundle ID value to filter by
versionstringyesVersion to filter by

[Jamf Pro] Updates an existing mobile device application by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. An omitted scope element empties the scope, which pulls the managed app from the devices that had it. Read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing mobile device application by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. An omitted scope element empties the scope, which pulls the managed app from the devices that had it. Read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Mobile Device Apps

ToolPlanAccessSummary
jamf_create_mobile_device_apps_reinstall_app_configProDestructiveReinstall App Config for Managed iOS Apps.

[Jamf Pro] Reinstall App Config for Managed iOS Apps. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this redeploys the managed app configuration to the target device, which restarts the app under new managed settings and can drop the state the app held.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Mobile Device Commands (Classic API)

ToolPlanAccessSummary
jamf_classic_create_mobiledevicecommands_commandProDestructiveCreates a new mobile device command.
jamf_classic_create_mobiledevicecommands_command_idProDestructiveCreates a new mobile device command.
jamf_classic_get_mobiledevicecommands_commandFreeRead-onlyFinds all mobile device commands for specified command.
jamf_classic_get_mobiledevicecommands_nameFreeRead-onlyFinds all mobile device commands by command name.
jamf_classic_get_mobiledevicecommands_uuidFreeRead-onlyFinds a mobile device command by UUID.
jamf_classic_list_mobiledevicecommandsFreeRead-onlyFinds all mobile device commands.

[Jamf Pro] Creates a new mobile device command. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this issues a live Apple MDM command to the mobile devices named in the XML body. The command set includes EraseDevice, DeviceLock, ClearPasscode, EnableLostMode, RestartDevice, ShutDownDevice and UnmanageDevice. Several are irreversible and reach the device within seconds of the call. Read the command name in the body before you send it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.

[Jamf Pro] Creates a new mobile device command. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE, AND IT FANS OUT: id_list is a comma-separated list of device IDs, so one call sends the command to every device in it. The command set includes EraseDevice, DeviceLock, ClearPasscode, EnableLostMode, RestartDevice, ShutDownDevice and UnmanageDevice. Count the IDs and confirm the command name before you send it; an EraseDevice against a long list wipes every device on it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
commandstringyesCommand to send device
idListstringyesMobile device ID values, multiple IDs may be separated by commas (e.g. /id/13,14,15)

[Jamf Pro] Finds all mobile device commands for specified command. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
commandstringyesName to filter by

[Jamf Pro] Finds all mobile device commands by command name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds a mobile device command by UUID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Looks one command up by the UUID Jamf Pro returned when the command was issued. This is how you poll whether a command completed, failed or is still pending.

ParamTypeRequiredDefaultDescription
uuidstringyesUUID value to filter by

[Jamf Pro] Finds all mobile device commands. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Lists the mobile device commands Jamf Pro has recorded, with their status. Use it to check whether a command such as EraseDevice or DeviceLock actually reached the device, rather than assuming the call that issued it succeeded.

Mobile Device Configuration Profiles (Classic API)

ToolPlanAccessSummary
jamf_classic_create_mobiledeviceconfigurationprofiles_idProWriteCreates a new mobile device configuration profile by ID.
jamf_classic_delete_mobiledeviceconfigurationprofiles_idProDestructiveDeletes a mobile device configuration profile by ID.
jamf_classic_delete_mobiledeviceconfigurationprofiles_nameProDestructiveDeletes a mobile device configuration profile by name.
jamf_classic_get_mobiledeviceconfigurationprofiles_idFreeRead-onlyFinds mobile device configuration profiles by ID.
jamf_classic_get_mobiledeviceconfigurationprofiles_id_subsetFreeRead-onlyFinds a subset of data for a mobile device configuration profile by ID.
jamf_classic_get_mobiledeviceconfigurationprofiles_nameFreeRead-onlyFinds mobile device configuration profiles by name.
jamf_classic_get_mobiledeviceconfigurationprofiles_name_subsetFreeRead-onlyFinds a subset of data for mobile device configuration profiles by name.
jamf_classic_list_mobiledeviceconfigurationprofilesFreeRead-onlyFinds all mobile device configuration profiles.
jamf_classic_update_mobiledeviceconfigurationprofiles_idProDestructiveUpdates an existing mobile device configuration profile by ID.
jamf_classic_update_mobiledeviceconfigurationprofiles_nameProDestructiveUpdates an existing mobile device configuration profile by name.

[Jamf Pro] Creates a new mobile device configuration profile by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device configuration profile by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the configuration profile. Jamf Pro removes it from every device in its scope, so the Wi-Fi, VPN, account or restriction settings it carried stop applying.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device configuration profile by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the configuration profile. Jamf Pro removes it from every device in its scope, so the Wi-Fi, VPN, account or restriction settings it carried stop applying.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds mobile device configuration profiles by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds a subset of data for a mobile device configuration profile by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds mobile device configuration profiles by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds a subset of data for mobile device configuration profiles by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds all mobile device configuration profiles. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Configuration profiles carry the restrictions, Wi-Fi, VPN, certificate and account settings pushed to mobile devices. What a profile applies to lives in its scope, which the single-profile reads return.

[Jamf Pro] Updates an existing mobile device configuration profile by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. An omitted scope element empties the scope, which removes the profile from every device that held it, and an edited payload is re-pushed to the devices still in scope. Read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing mobile device configuration profile by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. An omitted scope element empties the scope, which removes the profile from every device that held it, and an edited payload is re-pushed to the devices still in scope. Read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Mobile Device Enrollment Profile

ToolPlanAccessSummary
jamf_list_mobile_device_enrollment_profile_download_profileFreeRead-onlyRetrieve the MDM Enrollment Profile.

[Jamf Pro] Retrieve the MDM Enrollment Profile. This returns the enrollment profile itself as an Apple .mobileconfig document, not JSON, so expect XML property-list text in the response. It carries enrollment secrets: treat the output as sensitive and do not paste it where it will be retained.

ParamTypeRequiredDefaultDescription
idstringyesMDM Enrollment Profile identifier

Mobile Device Enrollment Profiles (Classic API)

ToolPlanAccessSummary
jamf_classic_create_mobiledeviceenrollmentprofiles_idProWriteCreates a new mobile device enrollment profile by ID.
jamf_classic_delete_mobiledeviceenrollmentprofiles_idProDestructiveDeletes a mobile device enrollment profile by ID.
jamf_classic_delete_mobiledeviceenrollmentprofiles_invitationProDestructiveDeletes a mobile device enrollment profile by invitation.
jamf_classic_delete_mobiledeviceenrollmentprofiles_nameProDestructiveDeletes a mobile device enrollment profile by name.
jamf_classic_get_mobiledeviceenrollmentprofiles_idFreeRead-onlyFinds mobile device enrollment profiles by ID.
jamf_classic_get_mobiledeviceenrollmentprofiles_id_subsetFreeRead-onlyFinds a subset of data for an enrollment profile.
jamf_classic_get_mobiledeviceenrollmentprofiles_invitationFreeRead-onlyFinds mobile device enrollment profiles by invitation.
jamf_classic_get_mobiledeviceenrollmentprofiles_nameFreeRead-onlyFinds mobile device enrollment profiles by name.
jamf_classic_get_mobiledeviceenrollmentprofiles_name_subsetFreeRead-onlyFinds a subset of data for mobile device enrollment profiles by name.
jamf_classic_list_mobiledeviceenrollmentprofilesFreeRead-onlyFinds all mobile device enrollment profiles.
jamf_classic_update_mobiledeviceenrollmentprofiles_idProDestructiveUpdates an existing mobile device enrollment profile by ID.
jamf_classic_update_mobiledeviceenrollmentprofiles_invitationProDestructiveUpdates an existing mobile device enrollment profile by invitation.
jamf_classic_update_mobiledeviceenrollmentprofiles_nameProDestructiveUpdates an existing mobile device enrollment profile by name.

[Jamf Pro] Creates a new mobile device enrollment profile by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device enrollment profile by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the enrollment profile. Invitations that pointed at it stop working, and devices cannot enroll through it any more.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device enrollment profile by invitation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the enrollment profile. Invitations that pointed at it stop working, and devices cannot enroll through it any more.

ParamTypeRequiredDefaultDescription
invitationstringyesInvitation value to filter by

[Jamf Pro] Deletes a mobile device enrollment profile by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the enrollment profile. Invitations that pointed at it stop working, and devices cannot enroll through it any more.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds mobile device enrollment profiles by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds a subset of data for an enrollment profile. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds mobile device enrollment profiles by invitation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
invitationstringyesInvitation value to filter by

[Jamf Pro] Finds mobile device enrollment profiles by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds a subset of data for mobile device enrollment profiles by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds all mobile device enrollment profiles. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. The enrollment profiles used for invitation-based enrollment. The outstanding invitations themselves are listed by jamf_classic_list_mobiledeviceinvitations.

[Jamf Pro] Updates an existing mobile device enrollment profile by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. Any element you leave out is cleared on the enrollment profile rather than left alone, so read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing mobile device enrollment profile by invitation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. Any element you leave out is cleared on the enrollment profile rather than left alone, so read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
invitationstringyesInvitation value to filter by

[Jamf Pro] Updates an existing mobile device enrollment profile by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. Any element you leave out is cleared on the enrollment profile rather than left alone, so read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Mobile Device Extension Attributes

ToolPlanAccessSummary
jamf_create_mobile_device_extension_attributesProWriteCreate Mobile Device Extension Attribute.
jamf_create_mobile_device_extension_attributes_historyProWriteAdd specified Mobile Device Extension Attribute history object notes.
jamf_delete_mobile_device_extension_attributesProDestructiveDelete a Mobile Device Extension Attribute by ID.
jamf_get_mobile_device_extension_attributesFreeRead-onlyGet specified Mobile Device Extension Attribute object.
jamf_list_mobile_device_extension_attributesFreeRead-onlyRetrieve Mobile Device Extension Attributes.
jamf_list_mobile_device_extension_attributes_data_dependencyFreeRead-onlyGet smart group dependent object for a specified mobile device extension attribute.
jamf_list_mobile_device_extension_attributes_historyFreeRead-onlyGet specified Mobile Device Extension Attribute History object.
jamf_update_mobile_device_extension_attributesProDestructiveUpdate specified Mobile Device Extension Attribute object.

[Jamf Pro] Create Mobile Device Extension Attribute. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Add specified Mobile Device Extension Attribute history object notes. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesInstance ID of Mobile Device Extension Attribute

[Jamf Pro] Delete a Mobile Device Extension Attribute by ID. DESTRUCTIVE: this deletes the extension attribute definition and the collected values on every mobile device record. Smart groups and advanced searches built on the attribute stop matching. Check what depends on it with jamf_list_mobile_device_extension_attributes_data_dependency first.

ParamTypeRequiredDefaultDescription
idstringyesUnique ID of Mobile Device Extension Attribute.
ParamTypeRequiredDefaultDescription
idstringyesUnique ID of Mobile Device Extension Attribute.

[Jamf Pro] Retrieve Mobile Device Extension Attributes. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Extension attributes are the custom mobile device inventory fields a Jamf Pro administrator defines. Before deleting one, check what depends on it with jamf_list_mobile_device_extension_attributes_data_dependency.

ParamTypeRequiredDefaultDescription
filterstringnonullFilters results. Use RSQL format for query. Allows for many fields, including ID, name, etc.<br/> Can be combined with paging and sorting.<br/> Fields allowed in the query: id, name <br/> Default filter is an empty query and returns all results from the requested page.
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorts results by one or more criteria, following the format property:asc/desc.<br/> Default sort is name:asc.<br/> If using multiple criteria, separate with commas. Allows sort for id and name.
ParamTypeRequiredDefaultDescription
idstringyesUnique ID of mobile device extension attribute.

[Jamf Pro] Get specified Mobile Device Extension Attribute History object. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullFilters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.
idstringyesInstance ID of Mobile Device Extension Attribute
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.

[Jamf Pro] Update specified Mobile Device Extension Attribute object. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE BECAUSE THIS PUT REPLACES THE WHOLE OBJECT: send every field. Changing the input type or the popup choices can discard values already collected from devices, so read the attribute with jamf_get_mobile_device_extension_attributes first and edit what it returns.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesUnique ID of Mobile Device Extension Attribute.

Mobile Device Extension Attributes (Classic API)

ToolPlanAccessSummary
jamf_classic_create_mobiledeviceextensionattributes_idProWriteCreates a new mobile device extension attribute by ID.
jamf_classic_delete_mobiledeviceextensionattributes_idProDestructiveDeletes a mobile device extension attribute by ID.
jamf_classic_delete_mobiledeviceextensionattributes_nameProDestructiveDeletes a mobile device extension attribute by name.
jamf_classic_get_mobiledeviceextensionattributes_idFreeRead-onlyFinds mobile device extension attributes by ID.
jamf_classic_get_mobiledeviceextensionattributes_nameFreeRead-onlyFinds mobiledeviceextensionattributes by name.
jamf_classic_list_mobiledeviceextensionattributesFreeRead-onlyFinds all mobile device extension attributes.
jamf_classic_update_mobiledeviceextensionattributes_idProDestructiveUpdates an existing mobile device extension attribute by ID.
jamf_classic_update_mobiledeviceextensionattributes_nameProDestructiveUpdates an existing mobile device extension attribute by name.

[Jamf Pro] Creates a new mobile device extension attribute by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device extension attribute by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the extension attribute definition and the collected values on every mobile device record. Smart groups and advanced searches built on the attribute stop matching.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device extension attribute by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the extension attribute definition and the collected values on every mobile device record. Smart groups and advanced searches built on the attribute stop matching.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds mobile device extension attributes by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds mobiledeviceextensionattributes by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all mobile device extension attributes. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Extension attributes are the custom mobile device inventory fields a Jamf Pro administrator defines. On the Jamf Pro API the same ground is covered by jamf_list_mobile_device_extension_attributes.

[Jamf Pro] Updates an existing mobile device extension attribute by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. Changing the input type or the popup choices can discard values already collected from devices, so read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing mobile device extension attribute by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. Changing the input type or the popup choices can discard values already collected from devices, so read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Mobile Device Groups

ToolPlanAccessSummary
jamf_create_mobile_device_groups_smart_groupsProWriteCreate a smart group.
jamf_create_mobile_device_groups_static_groupsProWriteCreate a static group.
jamf_delete_mobile_device_groups_smart_groupsProDestructiveRemove Smart Group by Id.
jamf_delete_mobile_device_groups_static_groupsProDestructiveRemove Static Group by Id.
jamf_erase_mobile_device_groupsProDestructiveErase all devices in the group.
jamf_get_mobile_device_groups_smart_group_membershipFreeRead-onlyGet Smart Group Membership by Id.
jamf_get_mobile_device_groups_smart_groupsFreeRead-onlyGet Smart Group by Id.
jamf_get_mobile_device_groups_static_group_membershipFreeRead-onlyGet Static Group Membership by Id.
jamf_get_mobile_device_groups_static_groupsFreeRead-onlyGet Static Group by Id.
jamf_list_mobile_device_groupsFreeRead-onlyReturn the list of all Mobile Device Groups.
jamf_list_mobile_device_groups_smart_groupsFreeRead-onlyGet Smart Groups.
jamf_list_mobile_device_groups_static_groupsFreeRead-onlyGet Static Groups.
jamf_patch_mobile_device_groups_static_groupsProWriteUpdate a static group.
jamf_update_mobile_device_groups_smart_groupsProDestructiveUpdate a smart group.

[Jamf Pro] Create a smart group. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
platformbooleannonullOptional. Return platform identifiers instead of internal identifiers when set to true.

[Jamf Pro] Create a static group. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
platformbooleannonullOptional. Return platform identifiers instead of internal identifiers when set to true.

[Jamf Pro] Remove Smart Group by Id. DESTRUCTIVE: this deletes the smart group. Every policy, profile and app scoped to it loses that scope, so devices can silently fall out of configuration they still need. Check the current membership with jamf_get_mobile_device_groups_smart_group_membership first.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of smart-group

[Jamf Pro] Remove Static Group by Id. DESTRUCTIVE: this deletes the static group. Every policy, profile and app scoped to it loses that scope, so devices can silently fall out of configuration they still need. Check the current membership with jamf_get_mobile_device_groups_static_group_membership first. To change membership without deleting the group, use jamf_patch_mobile_device_groups_static_groups.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of static-group

[Jamf Pro] Erase all devices in the group. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE, IRREVERSIBLE, AND IT FANS OUT ACROSS THE WHOLE GROUP: this erases EVERY mobile device in the group back to factory settings, not one device. A smart group can hold hundreds of devices and its membership changes on its own as criteria match. Check the current membership with jamf_get_mobile_device_groups_smart_group_membership or the static equivalent before you call this, and confirm the blast radius with the customer.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of mobile-device-group

[Jamf Pro] Get Smart Group Membership by Id. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter mobile device collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`, `serialNumber`, `sharedIpad`, `supervised`, `tethered`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp` Extension attributes can be filtered by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null` This param can be combined with paging and sorting. Example: `filter=displayName=="iPad"`
idstringyesinstance id of smart-group
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is mobileDeviceId:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `batteryHealth`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `enrollmentSessionTokenValid`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`, `osRapidSecurityResponse`, `osSupplementalBuildVersion`, `osVersion`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastBackupDate`, `lastEnrolledDate`, `lastCloudBackupDate`, `lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`, `serialNumber`, `sharedIpad`, `supervised`, `tethered`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `deviceOwnershipType`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`, `poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp` Extension attributes can be sorted by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null` Example: `sort=displayName:desc,username:asc`
ParamTypeRequiredDefaultDescription
idstringyesinstance id of smart-group

[Jamf Pro] Get Static Group Membership by Id. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter mobile device collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`, `serialNumber`, `sharedIpad`, `supervised`, `tethered`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp` Extension attributes can be filtered by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null` This param can be combined with paging and sorting. Example: `filter=displayName=="iPad"`
idstringyesinstance id of static-group
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is mobileDeviceId:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `batteryHealth`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `enrollmentSessionTokenValid`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`, `osRapidSecurityResponse`, `osSupplementalBuildVersion`, `osVersion`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastBackupDate`, `lastEnrolledDate`, `lastCloudBackupDate`, `lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`, `serialNumber`, `sharedIpad`, `supervised`, `tethered`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `deviceOwnershipType`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`, `poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp` Extension attributes can be sorted by using the format `EA+ID` where ID is the ID of the extension attribute, for example `EA+1!=null` Example: `sort=displayName:desc,username:asc`
ParamTypeRequiredDefaultDescription
idstringyesinstance id of static-group

[Jamf Pro] Return the list of all Mobile Device Groups. Lists every mobile device group. Feed the id to jamf_get_mobile_device_groups_smart_group_membership or jamf_get_mobile_device_groups_static_group_membership to see which devices are actually in it, which is worth doing before anything scoped to a group.

[Jamf Pro] Get Smart Groups. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Smart groups only. Membership is computed from criteria and changes on its own, so read jamf_get_mobile_device_groups_smart_group_membership for the devices in scope right now.

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter smart group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: groupId, groupName, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. This param can be combined with paging and sorting. Example: groupName=="smartGroup1"
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is groupId:asc. Available criteria to sort on: groupId, groupName, siteId.

[Jamf Pro] Get Static Groups. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Static groups only. Membership is an explicit list, changed with jamf_patch_mobile_device_groups_static_groups.

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter static group collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: groupId, groupName, siteId. The siteId field can only be filtered by admins with full access. Any sited admin will have siteId filtered automatically. This param can be combined with paging and sorting. Example: groupName=="staticGroup1"
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is groupId:asc. Available criteria to sort on: groupId, groupName, siteId.

[Jamf Pro] Update a static group. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of static-group

[Jamf Pro] Update a smart group. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE BECAUSE THIS PUT REPLACES THE WHOLE OBJECT: send every field. Rewriting the criteria changes membership immediately, which adds or removes devices from everything scoped to the group. Read the group with jamf_get_mobile_device_groups_smart_groups first and edit what it returns.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of a smart group

Mobile Device Groups (Classic API)

ToolPlanAccessSummary
jamf_classic_create_mobiledevicegroups_idProWriteCreates a new mobile device group by ID.
jamf_classic_delete_mobiledevicegroups_idProDestructiveDeletes a mobile device group by ID.
jamf_classic_delete_mobiledevicegroups_nameProDestructiveDeletes a mobile device group by name.
jamf_classic_get_mobiledevicegroups_idFreeRead-onlyFinds mobile device groups by ID.
jamf_classic_get_mobiledevicegroups_nameFreeRead-onlyFinds mobile device groups by name.
jamf_classic_list_mobiledevicegroupsFreeRead-onlyFinds all mobile device groups.
jamf_classic_update_mobiledevicegroups_idProDestructiveUpdates an existing mobile device group by ID.
jamf_classic_update_mobiledevicegroups_nameProDestructiveUpdates an existing mobile device group by name.

[Jamf Pro] Creates a new mobile device group by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device group by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the mobile device group. Every policy, profile and app scoped to the group loses that scope, so devices can silently fall out of configuration they still need.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device group by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the mobile device group. Every policy, profile and app scoped to the group loses that scope, so devices can silently fall out of configuration they still need.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds mobile device groups by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds mobile device groups by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all mobile device groups. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Lists every mobile device group, smart and static. On the Jamf Pro API the same ground is covered by jamf_list_mobile_device_groups, with membership available from jamf_get_mobile_device_groups_smart_group_membership and its static equivalent.

[Jamf Pro] Updates an existing mobile device group by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. An omitted membership or criteria element empties the group, and everything scoped to that group loses those devices. Read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing mobile device group by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. An omitted membership or criteria element empties the group, and everything scoped to that group loses those devices. Read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Mobile Device History (Classic API)

ToolPlanAccessSummary
jamf_classic_get_mobiledevicehistory_idFreeRead-onlyFinds mobile device history by ID.
jamf_classic_get_mobiledevicehistory_id_subsetFreeRead-onlyfinds a subset of data for a mobile device history.
jamf_classic_get_mobiledevicehistory_macaddressFreeRead-onlyFinds mobile device history by wifi mac address.
jamf_classic_get_mobiledevicehistory_macaddress_subsetFreeRead-onlyFinds a subset of data for mobile device history by wifi mac address.
jamf_classic_get_mobiledevicehistory_nameFreeRead-onlyFinds mobile device history by name.
jamf_classic_get_mobiledevicehistory_name_subsetFreeRead-onlyFinds a subset of data for mobile device history by name.
jamf_classic_get_mobiledevicehistory_serialnumberFreeRead-onlyFinds mobile device history by serial number.
jamf_classic_get_mobiledevicehistory_serialnumber_subsetFreeRead-onlyFinds a subset of data for mobile device history by serial number.
jamf_classic_get_mobiledevicehistory_udidFreeRead-onlyFinds mobile device history by UDID.
jamf_classic_get_mobiledevicehistory_udid_subsetFreeRead-onlyFinds a subset of data for mobile device history by UDID.

[Jamf Pro] Finds mobile device history by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. The management history of one device: the commands sent to it, the apps and profiles applied, and the user changes recorded. This is the tool that answers what happened to this device and when. Look up the device first with jamf_list_mobile_devices or one of the Classic identifier lookups.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] finds a subset of data for a mobile device history. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds mobile device history by wifi mac address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
macaddressstringyesMac address to filter by

[Jamf Pro] Finds a subset of data for mobile device history by wifi mac address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
macaddressstringyesMac address to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds mobile device history by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds a subset of data for mobile device history by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds mobile device history by serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. The management history of one device, found by hardware serial number rather than by Jamf Pro ID.

ParamTypeRequiredDefaultDescription
serialnumberstringyesSerial number to filter by

[Jamf Pro] Finds a subset of data for mobile device history by serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
serialnumberstringyesSerial number to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds mobile device history by UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
udidstringyesUDID to filter by

[Jamf Pro] Finds a subset of data for mobile device history by UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
subsetstringyesSubset to filter by
udidstringyesUDID to filter by

Mobile Device Invitations (Classic API)

ToolPlanAccessSummary
jamf_classic_create_mobiledeviceinvitations_idProDestructiveCreates a new mobile device invitation by id.
jamf_classic_create_mobiledeviceinvitations_invitationProDestructiveCreates a new mobile device invitation by invitation.
jamf_classic_delete_mobiledeviceinvitations_idProDestructiveDeletes a mobile device invitation by id.
jamf_classic_delete_mobiledeviceinvitations_invitationProDestructiveDeletes a mobile device invitation by invitation.
jamf_classic_get_mobiledeviceinvitations_idFreeRead-onlyFinds mobile device invitations by id.
jamf_classic_get_mobiledeviceinvitations_invitationFreeRead-onlyFinds mobile device invitations by invitation.
jamf_classic_list_mobiledeviceinvitationsFreeRead-onlyFinds all mobile device invitations.

[Jamf Pro] Creates a new mobile device invitation by id. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE IT REACHES A PERSON: creating an invitation sends an enrollment message to the email address or phone number in the body. You cannot recall a message once Jamf Pro has sent it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Creates a new mobile device invitation by invitation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE IT REACHES A PERSON: creating an invitation sends an enrollment message to the email address or phone number in the body. You cannot recall a message once Jamf Pro has sent it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
invitationstringyesInvitation value to filter by

[Jamf Pro] Deletes a mobile device invitation by id. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the enrollment invitation. Anyone who still holds the invitation link or code can no longer use it to enroll.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device invitation by invitation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the enrollment invitation. Anyone who still holds the invitation link or code can no longer use it to enroll.

ParamTypeRequiredDefaultDescription
invitationstringyesInvitation value to filter by

[Jamf Pro] Finds mobile device invitations by id. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds mobile device invitations by invitation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
invitationstringyesInvitation value to filter by

[Jamf Pro] Finds all mobile device invitations. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. The outstanding mobile device enrollment invitations. Creating one sends a message to a person, so read this list before issuing another invitation to the same address.

Mobile Device Prestages

ToolPlanAccessSummary
jamf_create_mobile_device_prestagesProWriteCreate a Mobile Device Prestage.
jamf_create_mobile_device_prestages_attachmentsProWriteAdd an attachment to a Mobile Device Prestage.
jamf_create_mobile_device_prestages_historyProWriteAdd Mobile Device Prestage history object notes.
jamf_create_mobile_device_prestages_scopeProWriteAdd Device Scope for a specific Mobile Device Prestage.
jamf_delete_mobile_device_prestagesProDestructiveDelete a Mobile Device Prestage with the supplied id.
jamf_delete_multiple_mobile_device_prestages_attachmentsProDestructiveRemove an attachment for a Mobile Device Prestage.
jamf_delete_multiple_mobile_device_prestages_scopeProDestructiveRemove Device Scope for a specific Mobile Device Prestage.
jamf_get_mobile_device_prestagesFreeRead-onlyRetrieve a Mobile Device Prestage with the supplied id.
jamf_list_mobile_device_prestagesFreeRead-onlyGet sorted and paged Mobile Device Prestages.
jamf_list_mobile_device_prestages_attachmentsFreeRead-onlyGet attachments for a Mobile Device Prestage.
jamf_list_mobile_device_prestages_historyFreeRead-onlyGet sorted and paged Mobile Device Prestage history objects.
jamf_list_mobile_device_prestages_scopeFreeRead-onlyGet all Device Scope for all Mobile Device Prestages.
jamf_list_mobile_device_prestages_scope_idFreeRead-onlyGet Device Scope for a specific Mobile Device Prestage.
jamf_list_mobile_device_prestages_syncsFreeRead-onlyGet all Prestage sync States for all prestages.
jamf_list_mobile_device_prestages_syncs_idFreeRead-onlyGet all prestage sync states for a single prestage.
jamf_list_mobile_device_prestages_syncs_latestFreeRead-onlyGet the latest Sync State for a single Prestage.
jamf_update_mobile_device_prestagesProDestructiveUpdate a Mobile Device Prestage.
jamf_update_mobile_device_prestages_scopeProDestructiveReplace Device Scope for a specific Mobile Device Prestage.

[Jamf Pro] Create a Mobile Device Prestage. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Add an attachment to a Mobile Device Prestage. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesIdentifier of the Mobile Device Prestage the attachment should be assigned to

[Jamf Pro] Add Mobile Device Prestage history object notes. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesMobile Device Prestage identifier

[Jamf Pro] Add Device Scope for a specific Mobile Device Prestage. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesMobile Device Prestage identifier

[Jamf Pro] Delete a Mobile Device Prestage with the supplied id. DESTRUCTIVE: this deletes the PreStage enrollment. Every device assigned to its scope loses the configuration it would have received at the next wipe or out-of-box enrollment, and those devices enroll unconfigured instead. Check the scope with jamf_list_mobile_device_prestages_scope_id first.

ParamTypeRequiredDefaultDescription
idstringyesMobile Device Prestage identifier

[Jamf Pro] Remove an attachment for a Mobile Device Prestage. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE, AND IT FANS OUT: every attachment ID in the body is deleted from this PreStage in one call, and the uploaded files are not recoverable through the API.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesMobile Device Prestage identifier

[Jamf Pro] Remove Device Scope for a specific Mobile Device Prestage. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE, AND IT FANS OUT: every serial number in the body is removed from this PreStage scope in one call. Those devices enroll unconfigured at their next wipe until they are assigned again.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesMobile Device Prestage identifier

[Jamf Pro] Retrieve a Mobile Device Prestage with the supplied id. Takes the id from jamf_list_mobile_device_prestages. The record carries a versionLock value that jamf_update_mobile_device_prestages needs, so read before you write.

ParamTypeRequiredDefaultDescription
idstringyesMobile Device Prestage identifier

[Jamf Pro] Get sorted and paged Mobile Device Prestages. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. PreStage enrollments decide what a device is configured with when it enrolls out of the box or after a wipe. Feed the id to jamf_list_mobile_device_prestages_scope_id to see which serial numbers are assigned to it.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc
ParamTypeRequiredDefaultDescription
idstringyesMobile Device Prestage identifier

[Jamf Pro] Get sorted and paged Mobile Device Prestage history objects. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
idstringyesMobile Device Prestage identifier
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property,asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is duplicated for each sort criterion, e.g., ...&sort=name%2Casc&sort=date%2Cdesc

[Jamf Pro] Get Device Scope for a specific Mobile Device Prestage. The serial numbers assigned to one PreStage. Read this before changing a scope: jamf_create_mobile_device_prestages_scope adds to it, while jamf_update_mobile_device_prestages_scope replaces it entirely.

ParamTypeRequiredDefaultDescription
idstringyesMobile Device Prestage identifier
ParamTypeRequiredDefaultDescription
idstringyesMobile Device Prestage identifier
ParamTypeRequiredDefaultDescription
idstringyesMobile Device Prestage identifier

[Jamf Pro] Update a Mobile Device Prestage. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE BECAUSE THIS PUT REPLACES THE WHOLE OBJECT: send every field, including the versionLock value from the record you read. An omitted field is cleared rather than left alone, and what this record holds is what a device is configured with at its next wipe. Read the PreStage with jamf_get_mobile_device_prestages first and edit what it returns.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesMobile Device Prestage identifier

[Jamf Pro] Replace Device Scope for a specific Mobile Device Prestage. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE BECAUSE IT REPLACES THE WHOLE SCOPE: the serial numbers in the body become the entire scope, so every serial you leave out is removed from this PreStage. To ADD devices without disturbing the ones already assigned, use jamf_create_mobile_device_prestages_scope instead.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesMobile Device Prestage identifier

Mobile Device Provisioning Profiles (Classic API)

ToolPlanAccessSummary
jamf_classic_create_mobiledeviceprovisioningprofiles_idProWriteCreates a mobile device provisioning profiles by id.
jamf_classic_create_mobiledeviceprovisioningprofiles_nameProWriteCreates a mobile device provisioning profiles by name.
jamf_classic_create_mobiledeviceprovisioningprofiles_uuidProWriteCreates a mobile device provisioning profiles by uuid.
jamf_classic_delete_mobiledeviceprovisioningprofiles_idProDestructiveDeletes a mobile device provisioning profiles by id.
jamf_classic_delete_mobiledeviceprovisioningprofiles_nameProDestructiveDeletes a mobile device provisioning profiles by name.
jamf_classic_delete_mobiledeviceprovisioningprofiles_uuidProDestructiveDeletes a mobile device provisioning profiles by uuid.
jamf_classic_get_mobiledeviceprovisioningprofiles_idFreeRead-onlyFinds a mobile device provisioning profiles by id.
jamf_classic_get_mobiledeviceprovisioningprofiles_nameFreeRead-onlyFinds a mobile device provisioning profiles by name.
jamf_classic_get_mobiledeviceprovisioningprofiles_uuidFreeRead-onlyFinds a mobile device provisioning profiles by uuid.
jamf_classic_list_mobiledeviceprovisioningprofilesFreeRead-onlyFinds all mobile device provisioning profiles.
jamf_classic_update_mobiledeviceprovisioningprofiles_idProDestructiveUpdates an existing mobile device provisioning profiles by id.
jamf_classic_update_mobiledeviceprovisioningprofiles_nameProDestructiveUpdates an existing mobile device provisioning profiles by name.
jamf_classic_update_mobiledeviceprovisioningprofiles_uuidProDestructiveUpdates an existing mobile device provisioning profiles by uuid.

[Jamf Pro] Creates a mobile device provisioning profiles by id. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesId value to filter by

[Jamf Pro] Creates a mobile device provisioning profiles by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

[Jamf Pro] Creates a mobile device provisioning profiles by uuid. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
uuidstringyesUuid value to filter by

[Jamf Pro] Deletes a mobile device provisioning profiles by id. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the provisioning profile. In-house apps signed against it stop launching on devices once their current profile expires.

ParamTypeRequiredDefaultDescription
idstringyesId value to filter by

[Jamf Pro] Deletes a mobile device provisioning profiles by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the provisioning profile. In-house apps signed against it stop launching on devices once their current profile expires.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Deletes a mobile device provisioning profiles by uuid. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the provisioning profile. In-house apps signed against it stop launching on devices once their current profile expires.

ParamTypeRequiredDefaultDescription
uuidstringyesUuid value to filter by

[Jamf Pro] Finds a mobile device provisioning profiles by id. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesId value to filter by

[Jamf Pro] Finds a mobile device provisioning profiles by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds a mobile device provisioning profiles by uuid. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
uuidstringyesUuid value to filter by

[Jamf Pro] Finds all mobile device provisioning profiles. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. The iOS provisioning profiles uploaded to Jamf Pro for in-house apps. Each can be fetched by ID, name or UUID.

[Jamf Pro] Updates an existing mobile device provisioning profiles by id. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. Replacing the uploaded profile can stop in-house apps launching on devices, so read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesId value to filter by

[Jamf Pro] Updates an existing mobile device provisioning profiles by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. Replacing the uploaded profile can stop in-house apps launching on devices, so read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

[Jamf Pro] Updates an existing mobile device provisioning profiles by uuid. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. Replacing the uploaded profile can stop in-house apps launching on devices, so read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
uuidstringyesUuid value to filter by

Mobile Devices

ToolPlanAccessSummary
jamf_create_mobile_devices_recalculate_smart_groupsProWriteRecalculate all smart groups for the given device id and then return count of smart groups that device fall into.
jamf_erase_mobile_devicesProDestructiveErase a Mobile Device.
jamf_get_mobile_devicesFreeRead-onlyGet Mobile Device.
jamf_list_mobile_devicesFreeRead-onlyGet Mobile Device objects.
jamf_list_mobile_devices_detailFreeRead-onlyReturn paginated Mobile Device Inventory records.
jamf_list_mobile_devices_detail_idFreeRead-onlyGet Mobile Device.
jamf_list_mobile_devices_paired_devicesFreeRead-onlyReturn paginated Mobile Device Inventory records of all paired devices for the device.
jamf_patch_mobile_devicesProWriteUpdate fields on a mobile device that are allowed to be modified by users.
jamf_unmanage_mobile_devicesProDestructiveUnmanage a Mobile Device.
ParamTypeRequiredDefaultDescription
idstringyesid of mobile device

[Jamf Pro] Erase a Mobile Device. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE AND IRREVERSIBLE: this sends the Apple MDM EraseDevice command, which wipes the device back to factory settings. Anything not already backed up is lost, and Jamf Pro cannot undo it. Confirm the device identity with jamf_get_mobile_devices first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesId of the Mobile Device to erase

[Jamf Pro] Get Mobile Device. Takes the numeric id from jamf_list_mobile_devices. This returns the summary record only; for hardware, applications, security and user sections use jamf_list_mobile_devices_detail_id.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of mobile device record

[Jamf Pro] Get Mobile Device objects. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. Start here for iPhone, iPad and Apple TV inventory. Each record carries the numeric id, name, serial number and UDID. Feed that id to jamf_get_mobile_devices for one summary record, to jamf_list_mobile_devices_detail_id for the full inventory sections, or to jamf_list_devices_groups for the groups the device belongs to.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Return paginated Mobile Device Inventory records. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Returns the full inventory record for every mobile device, one page at a time. Name only the sections you need in section, because pulling every section across a large fleet is slow and most answers need one or two.

ParamTypeRequiredDefaultDescription
exceptionHandlingstringnonullControls how the endpoint handles exceptions when processing device data. - STRICT (default): Returns a 500 error with details when a device has data processing issues. Each problematic device is surfaced one at a time. - LENIENT: Returns a 200 response even when devices have processing issues. Problematic sections will be null in the response, and all devices (including those with issues) are included. Exceptions are logged to the Jamf Pro Server logs.
filterstringnonullQuery in the RSQL format, allowing to filter mobile device collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastContactDate`, `lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`, `serialNumber`, `sharedIpad`, `supervised`, `tethered`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`, `groupId`, `groupName` This param can be combined with paging and sorting. Example: `filter=displayName=="iPad"`
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sectionstringnonullsection of mobile device details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&section=HARDWARE
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is displayName:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `batteryHealth`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `enrollmentSessionTokenValid`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastBackupDate`, `lastContactDate`, `lastEnrolledDate`, `lastCloudBackupDate`, `lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`, `serialNumber`, `sharedIpad`, `supervised`, `tethered`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `deviceOwnershipType`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`, `poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp` Example: `sort=displayName:desc,username:asc`

[Jamf Pro] Get Mobile Device. Takes the numeric id from jamf_list_mobile_devices and returns that one device with the inventory sections you ask for.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of mobile device record

[Jamf Pro] Return paginated Mobile Device Inventory records of all paired devices for the device. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Returns the devices paired with this one, such as an Apple Watch paired to a managed iPhone.

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter mobile device collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `languages`, `lastContactDate`, `lastInventoryUpdateDate`, `locales`, `lostModeEnabled`, `managed`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `serialNumber`, `supervised`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`, `groupId`, `groupName` This param can be combined with paging and sorting. Example: `filter=displayName=="iPad"`
idstringyesinstance id of mobile device record
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sectionstringnonullsection of mobile device details, if not specified, Paired Devices section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&section=HARDWARE
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is displayName:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`, `batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`, `lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `enrollmentSessionTokenValid`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `languages`, `lastContactDate`, `lastEnrolledDate`, `lastCloudBackupDate`, `lastInventoryUpdateDate`, `locales`, `lostModeEnabled`, `managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `serialNumber`, `supervised`, `timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`, `deviceOwnershipType`, `building`, `department`, `emailAddress`, `fullName`, `userPhoneNumber`, `position`, `room`, `username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`, `poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`, `activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`, `hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`, `cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`, `imei`, `imei2`, `meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp` Example: `sort=displayName:desc,username:asc`

[Jamf Pro] Update fields on a mobile device that are allowed to be modified by users. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of mobile device record

[Jamf Pro] Unmanage a Mobile Device. DESTRUCTIVE: this removes the MDM profile from the device. The device stops receiving configuration profiles, managed apps and commands, and it drops out of Jamf Pro management. Getting it back needs a hands-on re-enrollment, so treat this as a one-way step for any device you cannot physically reach.

ParamTypeRequiredDefaultDescription
idstringyesId of the mobile device to remove the MDM profile from

Mobile Devices (Classic API)

ToolPlanAccessSummary
jamf_classic_create_mobiledevices_idProWriteCreates a new mobile device by ID.
jamf_classic_delete_mobiledevices_idProDestructiveDeletes a mobile device by ID.
jamf_classic_delete_mobiledevices_macaddressProDestructiveDeletes a mobile device by Mac address.
jamf_classic_delete_mobiledevices_nameProDestructiveDeletes a mobile device by name.
jamf_classic_delete_mobiledevices_serialnumberProDestructiveDeletes a mobile device by serial number.
jamf_classic_delete_mobiledevices_udidProDestructiveDeletes a mobile device by UDID.
jamf_classic_get_mobiledevices_idFreeRead-onlyFinds mobile devices by ID.
jamf_classic_get_mobiledevices_id_subsetFreeRead-onlyFinds a subset of data for a mobile device.
jamf_classic_get_mobiledevices_macaddressFreeRead-onlyFinds mobile devices by Mac address.
jamf_classic_get_mobiledevices_macaddress_subsetFreeRead-onlyFinds a subset of data for mobile devices by Mac address.
jamf_classic_get_mobiledevices_matchFreeRead-onlySearches for mobile devices that match the provided parameter.
jamf_classic_get_mobiledevices_nameFreeRead-onlyFinds mobile devices by name.
jamf_classic_get_mobiledevices_name_subsetFreeRead-onlyFinds a subset of data for mobile devices by name.
jamf_classic_get_mobiledevices_serialnumberFreeRead-onlyFinds mobile devices by serial number.
jamf_classic_get_mobiledevices_serialnumber_subsetFreeRead-onlyFinds a subset of data for mobile devices by serial number.
jamf_classic_get_mobiledevices_udidFreeRead-onlyFinds mobile devices by UDID.
jamf_classic_get_mobiledevices_udid_subsetFreeRead-onlyFinds a subset of data for mobile devices by UDID.
jamf_classic_list_mobiledevicesFreeRead-onlyFinds all mobile devices.
jamf_classic_update_mobiledevices_idProDestructiveUpdates an existing mobile device by ID.
jamf_classic_update_mobiledevices_macaddressProDestructiveUpdates an existing mobile device by Mac address.
jamf_classic_update_mobiledevices_nameProDestructiveUpdates an existing mobile device by name.
jamf_classic_update_mobiledevices_serialnumberProDestructiveUpdates an existing mobile device by serial number.
jamf_classic_update_mobiledevices_udidProDestructiveUpdates an existing mobile device by UDID.

[Jamf Pro] Creates a new mobile device by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this removes the mobile device record from Jamf Pro. Its inventory, management history and group membership go with it, and the device itself is left unmanaged rather than wiped. Confirm you have the right device before you call this.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a mobile device by Mac address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this removes the mobile device record from Jamf Pro. Its inventory, management history and group membership go with it, and the device itself is left unmanaged rather than wiped. Confirm you have the right device before you call this.

ParamTypeRequiredDefaultDescription
macaddressstringyesMac address value to filter by

[Jamf Pro] Deletes a mobile device by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this removes the mobile device record from Jamf Pro. Its inventory, management history and group membership go with it, and the device itself is left unmanaged rather than wiped. Confirm you have the right device before you call this.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Deletes a mobile device by serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this removes the mobile device record from Jamf Pro. Its inventory, management history and group membership go with it, and the device itself is left unmanaged rather than wiped. Confirm you have the right device before you call this.

ParamTypeRequiredDefaultDescription
serialnumberstringyesSerial number value to filter by

[Jamf Pro] Deletes a mobile device by UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this removes the mobile device record from Jamf Pro. Its inventory, management history and group membership go with it, and the device itself is left unmanaged rather than wiped. Confirm you have the right device before you call this.

ParamTypeRequiredDefaultDescription
udidstringyesUDID value to filter by

[Jamf Pro] Finds mobile devices by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Takes the Classic numeric ID. For one section of the record instead of all of it, use jamf_classic_get_mobiledevices_id_subset.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds a subset of data for a mobile device. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Returns one named section of the record instead of the whole thing. The sections are General, Location, Purchasing, Applications, Security, Network, Certificates, ConfigurationProfiles, ProvisioningProfiles and ExtensionAttributes.

ParamTypeRequiredDefaultDescription
idstringyesID to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds mobile devices by Mac address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Looks a device up by Wi-Fi MAC address. Useful when the only evidence is a network log.

ParamTypeRequiredDefaultDescription
macaddressstringyesMac address to filter by

[Jamf Pro] Finds a subset of data for mobile devices by Mac address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
macaddressstringyesMac address to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Searches for mobile devices that match the provided parameter. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Search rather than exact lookup: match accepts a name, serial number, UDID or MAC address and supports * as a wildcard. Reach for this when the caller has only a fragment of an identifier.

ParamTypeRequiredDefaultDescription
matchstringyesName, mac address, etc. to filter by. Match uses the same format as the general search in Jamf Pro.

[Jamf Pro] Finds mobile devices by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Looks a device up by its display name in Jamf Pro. Names are not guaranteed unique, so prefer the serial number or UDID lookup whenever the caller has one.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds a subset of data for mobile devices by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds mobile devices by serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Looks a device up by hardware serial number, which is the identifier printed on the device and the one an asset register usually holds. Use this when the caller quotes a serial rather than a Jamf Pro ID.

ParamTypeRequiredDefaultDescription
serialnumberstringyesSerial number to filter by

[Jamf Pro] Finds a subset of data for mobile devices by serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
serialnumberstringyesSerial number to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds mobile devices by UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Looks a device up by UDID, the unique identifier Apple assigns to the hardware.

ParamTypeRequiredDefaultDescription
udidstringyesUDID to filter by

[Jamf Pro] Finds a subset of data for mobile devices by UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
subsetstringyesSubset to filter by
udidstringyesUDID to filter by

[Jamf Pro] Finds all mobile devices. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. This is the Classic API view of the fleet. Prefer jamf_list_mobile_devices for new work; the Classic family earns its place through the identifier lookups below it, which find a device by serial number, UDID, MAC address or name.

[Jamf Pro] Updates an existing mobile device by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. An omitted element is cleared on the device record rather than left alone, which is how inventory and Location assignments get wiped by an edit meant to change one field. Read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing mobile device by Mac address. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. An omitted element is cleared on the device record rather than left alone, which is how inventory and Location assignments get wiped by an edit meant to change one field. Read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
macaddressstringyesMac address value to filter by

[Jamf Pro] Updates an existing mobile device by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. An omitted element is cleared on the device record rather than left alone, which is how inventory and Location assignments get wiped by an edit meant to change one field. Read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

[Jamf Pro] Updates an existing mobile device by serial number. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. An omitted element is cleared on the device record rather than left alone, which is how inventory and Location assignments get wiped by an edit meant to change one field. Read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
serialnumberstringyesSerial number value to filter by

[Jamf Pro] Updates an existing mobile device by UDID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. An omitted element is cleared on the device record rather than left alone, which is how inventory and Location assignments get wiped by an edit meant to change one field. Read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
udidstringyesUDID value to filter by

Personal Device Profiles (Classic API)

ToolPlanAccessSummary
jamf_classic_create_byoprofiles_idProWriteCreates a personal device profile by ID.
jamf_classic_delete_byoprofiles_idProDestructiveDeletes a personal device profile by ID.
jamf_classic_delete_byoprofiles_nameProDestructiveDeletes a personal device profile by name.
jamf_classic_get_byoprofiles_idFreeRead-onlyFinds personal device profile by ID.
jamf_classic_get_byoprofiles_nameFreeRead-onlyFinds a personal device profile by name.
jamf_classic_list_byoprofilesFreeRead-onlyFinds all personal device profiles.
jamf_classic_update_byoprofiles_idProDestructiveUpdates a personal device profile by ID.
jamf_classic_update_byoprofiles_nameProDestructiveUpdates a personal device profile by name.

[Jamf Pro] Creates a personal device profile by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a personal device profile by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the personal device profile used for BYO enrollment. New BYO enrollments that relied on it stop working.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a personal device profile by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this deletes the personal device profile used for BYO enrollment. New BYO enrollments that relied on it stop working.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds personal device profile by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds a personal device profile by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all personal device profiles. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Personal device profiles govern BYO (bring your own) enrollment, where the device is owned by the person rather than the organization.

[Jamf Pro] Updates a personal device profile by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. Any element you leave out is cleared on the personal device profile rather than left alone, so read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates a personal device profile by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE BECAUSE THE CLASSIC API REPLACES WHOLESALE: send the complete XML document. Any element you leave out is cleared on the personal device profile rather than left alone, so read the current record first and edit what it returns.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Smart Mobile Device Groups

ToolPlanAccessSummary
jamf_create_smart_mobile_device_groups_recalculateProWriteRecalculate a smart group for the given id then return the ids for the devices in the smart group.
ParamTypeRequiredDefaultDescription
idstringyesinstance id of smart group

Allowed File Extensions (Classic API)

ToolPlanAccessSummary
jamf_classic_create_allowedfileextensions_idProWriteCreates a new allowed file extension value by ID.
jamf_classic_delete_allowedfileextensions_idProDestructiveDeletes an allowed file extension value by ID.
jamf_classic_get_allowedfileextensions_extensionFreeRead-onlyFinds an allowed file extension value by name.
jamf_classic_get_allowedfileextensions_idFreeRead-onlyFinds an allowed file extension value by ID.
jamf_classic_list_allowedfileextensionsFreeRead-onlyFinds the allowed file extensions.

[Jamf Pro] Creates a new allowed file extension value by ID. Allowed file extensions control which file types Jamf Pro accepts when an administrator uploads an attachment. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesDatabase ID of the extension

[Jamf Pro] Deletes an allowed file extension value by ID. Allowed file extensions control which file types Jamf Pro accepts when an administrator uploads an attachment. Removing an extension blocks every later upload that uses it. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesDatabase ID of the extension

[Jamf Pro] Finds an allowed file extension value by name. Allowed file extensions control which file types Jamf Pro accepts when an administrator uploads an attachment. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
extensionstringyesString value of extension

[Jamf Pro] Finds an allowed file extension value by ID. Allowed file extensions control which file types Jamf Pro accepts when an administrator uploads an attachment. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesDatabase ID of the extension

[Jamf Pro] Finds the allowed file extensions. Allowed file extensions control which file types Jamf Pro accepts when an administrator uploads an attachment. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

App Request

ToolPlanAccessSummary
jamf_create_app_request_form_input_fieldsProWriteCreate Form Input Field record.
jamf_delete_app_request_form_input_fieldsProDestructiveRemove specified Form Input Field record.
jamf_get_app_request_form_input_fieldsFreeRead-onlyGet specified Form Input Field object.
jamf_list_app_request_form_input_fieldsFreeRead-onlySearch for Form Input Fields.
jamf_list_app_request_settingsFreeRead-onlyGet Applicastion Request Settings.
jamf_update_app_request_form_input_fieldsProDestructiveReplace all Form Input Fields.
jamf_update_app_request_form_input_fields_idProDestructiveUpdate specified Form Input Field object.
jamf_update_app_request_settingsProDestructiveUpdate Application Request Settings.

[Jamf Pro] Create Form Input Field record. App Request lets a user ask for an App Store app from Self Service, and the form input fields define the questions on that request form. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Remove specified Form Input Field record. App Request lets a user ask for an App Store app from Self Service, and the form input fields define the questions on that request form. The field disappears from the request form that every Self Service user sees. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesInstance id of form input field record

[Jamf Pro] Get specified Form Input Field object. App Request lets a user ask for an App Store app from Self Service, and the form input fields define the questions on that request form.

ParamTypeRequiredDefaultDescription
idstringyesInstance id of form input field record

[Jamf Pro] Search for Form Input Fields. App Request lets a user ask for an App Store app from Self Service, and the form input fields define the questions on that request form.

[Jamf Pro] Get Applicastion Request Settings. App Request lets a user ask for an App Store app from Self Service, and the form input fields define the questions on that request form.

[Jamf Pro] Replace all Form Input Fields. App Request lets a user ask for an App Store app from Self Service, and the form input fields define the questions on that request form. The change reaches the request form that every Self Service user sees. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Update specified Form Input Field object. App Request lets a user ask for an App Store app from Self Service, and the form input fields define the questions on that request form. The change reaches the request form that every Self Service user sees. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesInstance id of form input field record

[Jamf Pro] Update Application Request Settings. App Request lets a user ask for an App Store app from Self Service, and the form input fields define the questions on that request form. The change reaches the request form that every Self Service user sees. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Cloud Distribution Point

ToolPlanAccessSummary
jamf_create_cloud_distribution_pointProWriteCreates the cloud distribution point.
jamf_create_cloud_distribution_point_fail_uploadProDestructiveMarks an in-progress upload to the cloud distribution point as failed.
jamf_create_cloud_distribution_point_historyProWriteAdd specified cloud distribution point history object notes.
jamf_create_cloud_distribution_point_refresh_inventoryProDestructiveUpdates the inventory data Jamf Pro holds for the configured cloud distribution point.
jamf_delete_cloud_distribution_pointProDestructiveDelete cloud distribution point.
jamf_list_cloud_distribution_pointFreeRead-onlyGet the cloud distribution point Details.
jamf_list_cloud_distribution_point_filesFreeRead-onlyGet the cloud distribution point Inventory files details.
jamf_list_cloud_distribution_point_historyFreeRead-onlyGet cloud distribution point history details.
jamf_list_cloud_distribution_point_test_connectionFreeRead-onlyReads the result of the cloud distribution point connection test, which reports whether Jamf Pro can reach the configured content delivery network.
jamf_list_cloud_distribution_point_upload_capabilityFreeRead-onlyFinds specific information for the currently configured cloud distribution point.
jamf_patch_cloud_distribution_pointProWriteUpdate specific fields on a cloud distribution point.

[Jamf Pro] Creates the cloud distribution point. Jamf accepts this only while the content delivery network type is None, so it cannot overwrite a distribution point that already exists. Use jamf_patch_cloud_distribution_point to change one that does. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Marks an in-progress upload to the cloud distribution point as failed. The upload is abandoned and the partial file is discarded. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fileNamestringyesName of the file to mark failure for.
idstringyesThe identifier of the inventory file to be marked as failed. The type and ID will make a unique identifier for the file.
typestringyesType of file to mark failure for. Possible values are PACKAGE, EBOOK, MOBILE_DEVICE_APP.

[Jamf Pro] Add specified cloud distribution point history object notes. The cloud distribution point is the content delivery network that Jamf Pro serves package files from. Use jamf_list_distribution_points for file share distribution points instead. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Updates the inventory data Jamf Pro holds for the configured cloud distribution point. Refreshing the inventory is what makes newly uploaded files deployable, which is why it carries the same classification as jamf_create_jcds_refresh_inventory. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fileNamestringnonullName of the file to check the availability of. If available, the inventory and status will be updated in Jamf Pro. If no file is specified, it will force an immediate inventory refresh at a rate-limit of once every 15 seconds.

[Jamf Pro] Delete cloud distribution point. The cloud distribution point is the content delivery network that Jamf Pro serves package files from. Use jamf_list_distribution_points for file share distribution points instead. Jamf Pro is left with no cloud distribution point, and every package hosted there stops being reachable. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

[Jamf Pro] Get the cloud distribution point Details. The cloud distribution point is the content delivery network that Jamf Pro serves package files from. Use jamf_list_distribution_points for file share distribution points instead.

[Jamf Pro] Get the cloud distribution point Inventory files details. The cloud distribution point is the content delivery network that Jamf Pro serves package files from. Use jamf_list_distribution_points for file share distribution points instead. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullFilters results. Use RSQL format for query. Allows for many fields, including fileName and type<br/> Can be combined with paging and sorting.<br/> Fields allowed in the query: fileName, inventoryId and type <br/> Default filter is an empty query and returns all results from the requested page.
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorts results by one or more criteria, following the format property:asc/desc.<br/> Default sort is id:asc.<br/> If using multiple criteria, separate with commas. Allows sort for id, fileName, inventoryId and type etc.

[Jamf Pro] Get cloud distribution point history details. The cloud distribution point is the content delivery network that Jamf Pro serves package files from. Use jamf_list_distribution_points for file share distribution points instead. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullFilters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.

[Jamf Pro] Finds specific information for the currently configured cloud distribution point. The cloud distribution point is the content delivery network that Jamf Pro serves package files from. Use jamf_list_distribution_points for file share distribution points instead.

[Jamf Pro] Update specific fields on a cloud distribution point. The cloud distribution point is the content delivery network that Jamf Pro serves package files from. Use jamf_list_distribution_points for file share distribution points instead. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Deploy Package

ToolPlanAccessSummary
jamf_create_deploy_packageProDestructiveDeploys one or more packages to named computers with an MDM install command.

[Jamf Pro] Deploys one or more packages to named computers with an MDM install command. This is a live install: the Macs you name download and install the package with no policy and no user consent. Confirm the package IDs and the target computer list before you run it. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
verbosebooleannonullEnables the 'verbose' response, which includes information about the commands queued as well as information about commands that failed to queue.

Directory Bindings (Classic API)

ToolPlanAccessSummary
jamf_classic_create_directorybindings_idProWriteCreates a new directory binding by ID.
jamf_classic_delete_directorybindings_idProDestructiveDeletes a directory binding by ID.
jamf_classic_delete_directorybindings_nameProDestructiveDeletes a directory binding by name.
jamf_classic_get_directorybindings_idFreeRead-onlyFinds directory bindings by ID.
jamf_classic_get_directorybindings_nameFreeRead-onlyFinds directory bindings by name.
jamf_classic_list_directorybindingsFreeRead-onlyFinds all directory bindings.
jamf_classic_update_directorybindings_idProDestructiveUpdates an existing directory binding by ID.
jamf_classic_update_directorybindings_nameProDestructiveUpdates an existing directory binding by name.

[Jamf Pro] Creates a new directory binding by ID. A directory binding record describes how a Mac joins a directory service. A policy is what applies it, so see jamf_classic_list_policies. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a directory binding by ID. A directory binding record describes how a Mac joins a directory service. A policy is what applies it, so see jamf_classic_list_policies. Every policy that binds Macs with this record stops working. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a directory binding by name. A directory binding record describes how a Mac joins a directory service. A policy is what applies it, so see jamf_classic_list_policies. Every policy that binds Macs with this record stops working. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds directory bindings by ID. A directory binding record describes how a Mac joins a directory service. A policy is what applies it, so see jamf_classic_list_policies. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds directory bindings by name. A directory binding record describes how a Mac joins a directory service. A policy is what applies it, so see jamf_classic_list_policies. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all directory bindings. A directory binding record describes how a Mac joins a directory service. A policy is what applies it, so see jamf_classic_list_policies. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing directory binding by ID. A directory binding record describes how a Mac joins a directory service. A policy is what applies it, so see jamf_classic_list_policies. Macs bound by a policy that uses this record follow the new settings the next time that policy runs. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing directory binding by name. A directory binding record describes how a Mac joins a directory service. A policy is what applies it, so see jamf_classic_list_policies. Macs bound by a policy that uses this record follow the new settings the next time that policy runs. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Disk Encryption Configurations (Classic API)

ToolPlanAccessSummary
jamf_classic_create_diskencryptionconfigurations_idProWriteCreates a new disk encryption configuration by ID.
jamf_classic_delete_diskencryptionconfigurations_idProDestructiveDeletes a disk encryption configuration by ID.
jamf_classic_delete_diskencryptionconfigurations_nameProDestructiveDeletes a disk encryption configuration by name.
jamf_classic_get_diskencryptionconfigurations_idFreeRead-onlyFinds disk encryption configurations by ID.
jamf_classic_get_diskencryptionconfigurations_nameFreeRead-onlyFinds disk encryption configurations by name.
jamf_classic_list_diskencryptionconfigurationsFreeRead-onlyFinds all disk encryption configurations.
jamf_classic_update_diskencryptionconfigurations_idProDestructiveUpdates an existing disk encryption configuration by ID.
jamf_classic_update_diskencryptionconfigurations_nameProDestructiveUpdates an existing disk encryption configuration by name.

[Jamf Pro] Creates a new disk encryption configuration by ID. A disk encryption configuration holds the FileVault settings that a policy or a configuration profile applies to a Mac. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a disk encryption configuration by ID. A disk encryption configuration holds the FileVault settings that a policy or a configuration profile applies to a Mac. Every policy that enables FileVault with this configuration stops working; Macs already encrypted stay encrypted. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a disk encryption configuration by name. A disk encryption configuration holds the FileVault settings that a policy or a configuration profile applies to a Mac. Every policy that enables FileVault with this configuration stops working; Macs already encrypted stay encrypted. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds disk encryption configurations by ID. A disk encryption configuration holds the FileVault settings that a policy or a configuration profile applies to a Mac. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds disk encryption configurations by name. A disk encryption configuration holds the FileVault settings that a policy or a configuration profile applies to a Mac. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all disk encryption configurations. A disk encryption configuration holds the FileVault settings that a policy or a configuration profile applies to a Mac. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing disk encryption configuration by ID. A disk encryption configuration holds the FileVault settings that a policy or a configuration profile applies to a Mac. Macs that take FileVault settings from this configuration follow the new values at the next policy run. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing disk encryption configuration by name. A disk encryption configuration holds the FileVault settings that a policy or a configuration profile applies to a Mac. Macs that take FileVault settings from this configuration follow the new values at the next policy run. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Distribution Points

ToolPlanAccessSummary
jamf_create_distribution_pointsProWriteCreate distribution point.
jamf_create_distribution_points_historyProWriteAdd specified distribution point History object notes.
jamf_delete_distribution_pointsProDestructiveRemove specified distribution point.
jamf_delete_multiple_distribution_pointsProDestructiveDeletes several distribution point records in one call.
jamf_get_distribution_pointsFreeRead-onlyGet specified distribution point.
jamf_list_distribution_pointsFreeRead-onlyFinds all Distribution Points.
jamf_list_distribution_points_historyFreeRead-onlyGet specified distribution point History object.
jamf_patch_distribution_pointsProWriteUpdate specified distribution point object.
jamf_update_distribution_pointsProDestructiveUpdate specified distribution point object.

[Jamf Pro] Create distribution point. Distribution points are the file shares that Jamf Pro serves package files from. This is the Jamf Pro API surface; jamf_classic_list_distributionpoints reaches the same records through the Classic API. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Add specified distribution point History object notes. Distribution points are the file shares that Jamf Pro serves package files from. This is the Jamf Pro API surface; jamf_classic_list_distributionpoints reaches the same records through the Classic API. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesInstance id of distribution point history

[Jamf Pro] Remove specified distribution point. Distribution points are the file shares that Jamf Pro serves package files from. This is the Jamf Pro API surface; jamf_classic_list_distributionpoints reaches the same records through the Classic API. Macs that download packages from this share can no longer reach them. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesInstance id of distribution point

[Jamf Pro] Deletes several distribution point records in one call. Macs that download packages from these shares can no longer reach them. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Get specified distribution point. Distribution points are the file shares that Jamf Pro serves package files from. This is the Jamf Pro API surface; jamf_classic_list_distributionpoints reaches the same records through the Classic API.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of distribution point

[Jamf Pro] Finds all Distribution Points. Distribution points are the file shares that Jamf Pro serves package files from. This is the Jamf Pro API surface; jamf_classic_list_distributionpoints reaches the same records through the Classic API. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullFilters results. Use RSQL format for query. Allows fields such as - name, serverName, principal, fileSharingConnectionType, and httpsEnabled Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorts results by one or more criteria, following the format property:asc/desc. Default sort is id:asc. If using multiple criteria, separate with commas. Allows fields such as - name, serverName

[Jamf Pro] Get specified distribution point History object. Distribution points are the file shares that Jamf Pro serves package files from. This is the Jamf Pro API surface; jamf_classic_list_distributionpoints reaches the same records through the Classic API. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullFilters results. Use RSQL format for query. Allows for many fields, including id, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.
idstringyesInstance id of distribution point history
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorts results by one or more criteria, following the format property:asc/desc. Default sort is id:asc. If using multiple criteria, separate with commas.

[Jamf Pro] Update specified distribution point object. Distribution points are the file shares that Jamf Pro serves package files from. This is the Jamf Pro API surface; jamf_classic_list_distributionpoints reaches the same records through the Classic API. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesInstance id of distribution point

[Jamf Pro] Update specified distribution point object. Distribution points are the file shares that Jamf Pro serves package files from. This is the Jamf Pro API surface; jamf_classic_list_distributionpoints reaches the same records through the Classic API. Macs that download packages from this share use the new address and credentials at the next policy run. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesInstance id of distribution point

Distribution Points (Classic API)

ToolPlanAccessSummary
jamf_classic_create_distributionpoints_idProWriteCreates a new distribution point by ID.
jamf_classic_delete_distributionpoints_idProDestructiveDeletes a distribution point by ID.
jamf_classic_delete_distributionpoints_nameProDestructiveDeletes a distribution point by name.
jamf_classic_get_distributionpoints_idFreeRead-onlyFinds distribution points by ID.
jamf_classic_get_distributionpoints_nameFreeRead-onlyFinds distribution points by name.
jamf_classic_list_distributionpointsFreeRead-onlyFinds all distribution points.
jamf_classic_update_distributionpoints_idProDestructiveUpdates an existing distribution point by ID.
jamf_classic_update_distributionpoints_nameProDestructiveUpdates an existing distribution point by name.

[Jamf Pro] Creates a new distribution point by ID. Distribution points are the file shares that Jamf Pro serves package files from. This is the Classic API surface; jamf_list_distribution_points reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a distribution point by ID. Distribution points are the file shares that Jamf Pro serves package files from. This is the Classic API surface; jamf_list_distribution_points reaches the same records through the newer Jamf Pro API. Macs that download packages from this share can no longer reach them. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a distribution point by name. Distribution points are the file shares that Jamf Pro serves package files from. This is the Classic API surface; jamf_list_distribution_points reaches the same records through the newer Jamf Pro API. Macs that download packages from this share can no longer reach them. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds distribution points by ID. Distribution points are the file shares that Jamf Pro serves package files from. This is the Classic API surface; jamf_list_distribution_points reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds distribution points by name. Distribution points are the file shares that Jamf Pro serves package files from. This is the Classic API surface; jamf_list_distribution_points reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all distribution points. Distribution points are the file shares that Jamf Pro serves package files from. This is the Classic API surface; jamf_list_distribution_points reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing distribution point by ID. Distribution points are the file shares that Jamf Pro serves package files from. This is the Classic API surface; jamf_list_distribution_points reaches the same records through the newer Jamf Pro API. Macs that download packages from this share use the new address and credentials at the next policy run. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing distribution point by name. Distribution points are the file shares that Jamf Pro serves package files from. This is the Classic API surface; jamf_list_distribution_points reaches the same records through the newer Jamf Pro API. Macs that download packages from this share use the new address and credentials at the next policy run. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Dock Items

ToolPlanAccessSummary
jamf_create_dock_itemsProWriteCreate a DockItem.
jamf_delete_dock_itemsProDestructiveDelete a DockItem at the specified id.
jamf_get_dock_itemsFreeRead-onlyRetrieve a full dockItem object.
jamf_update_dock_itemsProDestructiveReplace the dockItem at the id with the supplied information.

[Jamf Pro] Create a DockItem. A dock item record names an application or folder that a policy can add to or remove from the macOS Dock. This is the Jamf Pro API surface; jamf_classic_list_dockitems reaches the same records through the Classic API. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete a DockItem at the specified id. A dock item record names an application or folder that a policy can add to or remove from the macOS Dock. This is the Jamf Pro API surface; jamf_classic_list_dockitems reaches the same records through the Classic API. Every policy that places this item in the Dock stops working. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesDockItem object identifier

[Jamf Pro] Retrieve a full dockItem object. A dock item record names an application or folder that a policy can add to or remove from the macOS Dock. This is the Jamf Pro API surface; jamf_classic_list_dockitems reaches the same records through the Classic API.

ParamTypeRequiredDefaultDescription
idstringyesDockItem object identifier

[Jamf Pro] Replace the dockItem at the id with the supplied information. A dock item record names an application or folder that a policy can add to or remove from the macOS Dock. This is the Jamf Pro API surface; jamf_classic_list_dockitems reaches the same records through the Classic API. Policies that place this item in the Dock use the new values the next time they run. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesDockItem object identifier

Dock Items (Classic API)

ToolPlanAccessSummary
jamf_classic_create_dockitems_idProWriteCreates a new dock item by ID.
jamf_classic_delete_dockitems_idProDestructiveDeletes a dock item by ID.
jamf_classic_delete_dockitems_nameProDestructiveDeletes a dock item by name.
jamf_classic_get_dockitems_idFreeRead-onlyFinds dock items by ID.
jamf_classic_get_dockitems_nameFreeRead-onlyFinds dock items by name.
jamf_classic_list_dockitemsFreeRead-onlyFinds all dock items.
jamf_classic_update_dockitems_idProDestructiveUpdates an existing dock item by ID.
jamf_classic_update_dockitems_nameProDestructiveUpdates an existing dock item by name.

[Jamf Pro] Creates a new dock item by ID. A dock item record names an application or folder that a policy can add to or remove from the macOS Dock. This is the Classic API surface; jamf_get_dock_items reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a dock item by ID. A dock item record names an application or folder that a policy can add to or remove from the macOS Dock. This is the Classic API surface; jamf_get_dock_items reaches the same records through the newer Jamf Pro API. Every policy that places this item in the Dock stops working. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a dock item by name. A dock item record names an application or folder that a policy can add to or remove from the macOS Dock. This is the Classic API surface; jamf_get_dock_items reaches the same records through the newer Jamf Pro API. Every policy that places this item in the Dock stops working. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds dock items by ID. A dock item record names an application or folder that a policy can add to or remove from the macOS Dock. This is the Classic API surface; jamf_get_dock_items reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds dock items by name. A dock item record names an application or folder that a policy can add to or remove from the macOS Dock. This is the Classic API surface; jamf_get_dock_items reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all dock items. A dock item record names an application or folder that a policy can add to or remove from the macOS Dock. This is the Classic API surface; jamf_get_dock_items reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing dock item by ID. A dock item record names an application or folder that a policy can add to or remove from the macOS Dock. This is the Classic API surface; jamf_get_dock_items reaches the same records through the newer Jamf Pro API. Policies that place this item in the Dock use the new values the next time they run. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing dock item by name. A dock item record names an application or folder that a policy can add to or remove from the macOS Dock. This is the Classic API surface; jamf_get_dock_items reaches the same records through the newer Jamf Pro API. Policies that place this item in the Dock use the new values the next time they run. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Ebooks

ToolPlanAccessSummary
jamf_get_ebooksFreeRead-onlyGet specified Ebook object.
jamf_list_ebooksFreeRead-onlyGet Ebook object.
jamf_list_ebooks_scopeFreeRead-onlyGet specified scope of Ebook object.

[Jamf Pro] Get specified Ebook object. An eBook record distributes a book to the devices in its scope, through Self Service or automatic installation. This is the Jamf Pro API surface; jamf_classic_list_ebooks reaches the same records through the Classic API.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of ebook record

[Jamf Pro] Get Ebook object. An eBook record distributes a book to the devices in its scope, through Self Service or automatic installation. This is the Jamf Pro API surface; jamf_classic_list_ebooks reaches the same records through the Classic API. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Get specified scope of Ebook object. An eBook record distributes a book to the devices in its scope, through Self Service or automatic installation. This is the Jamf Pro API surface; jamf_classic_list_ebooks reaches the same records through the Classic API.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of ebook record

eBooks (Classic API)

ToolPlanAccessSummary
jamf_classic_create_ebooks_idProDestructiveCreates a new eBook record.
jamf_classic_delete_ebooks_idProDestructiveDeletes an ebook by ID.
jamf_classic_delete_ebooks_nameProDestructiveDeletes an ebook by name.
jamf_classic_get_ebooks_idFreeRead-onlyFinds ebooks by ID.
jamf_classic_get_ebooks_id_subsetFreeRead-onlyFinds a subset of data for an ebook by ID.
jamf_classic_get_ebooks_nameFreeRead-onlyFinds ebooks by name.
jamf_classic_get_ebooks_name_subsetFreeRead-onlyFinds a subset of data for ebooks by name.
jamf_classic_list_ebooksFreeRead-onlyFinds all ebooks.
jamf_classic_update_ebooks_idProDestructiveUpdates an existing ebook by ID.
jamf_classic_update_ebooks_nameProDestructiveUpdates an existing ebook by name.

[Jamf Pro] Creates a new eBook record. Creating a scoped record distributes the book to every device in that scope. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes an ebook by ID. An eBook record distributes a book to the devices in its scope, through Self Service or automatic installation. This is the Classic API surface; jamf_list_ebooks reaches the same records through the newer Jamf Pro API. The eBook is withdrawn from every device in its scope. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes an ebook by name. An eBook record distributes a book to the devices in its scope, through Self Service or automatic installation. This is the Classic API surface; jamf_list_ebooks reaches the same records through the newer Jamf Pro API. The eBook is withdrawn from every device in its scope. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds ebooks by ID. An eBook record distributes a book to the devices in its scope, through Self Service or automatic installation. This is the Classic API surface; jamf_list_ebooks reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds a subset of data for an ebook by ID. An eBook record distributes a book to the devices in its scope, through Self Service or automatic installation. This is the Classic API surface; jamf_list_ebooks reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds ebooks by name. An eBook record distributes a book to the devices in its scope, through Self Service or automatic installation. This is the Classic API surface; jamf_list_ebooks reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds a subset of data for ebooks by name. An eBook record distributes a book to the devices in its scope, through Self Service or automatic installation. This is the Classic API surface; jamf_list_ebooks reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds all ebooks. An eBook record distributes a book to the devices in its scope, through Self Service or automatic installation. This is the Classic API surface; jamf_list_ebooks reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing ebook by ID. An eBook record distributes a book to the devices in its scope, through Self Service or automatic installation. This is the Classic API surface; jamf_list_ebooks reaches the same records through the newer Jamf Pro API. The new scope and settings reach every affected device at the next check-in. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing ebook by name. An eBook record distributes a book to the devices in its scope, through Self Service or automatic installation. This is the Classic API surface; jamf_list_ebooks reaches the same records through the newer Jamf Pro API. The new scope and settings reach every affected device at the next check-in. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

File Uploads (Classic API)

ToolPlanAccessSummary
jamf_classic_create_fileuploadsProDestructiveUploads a file attachment to a Jamf Pro record such as a computer, a mobile device, or a policy.

[Jamf Pro] Uploads a file attachment to a Jamf Pro record such as a computer, a mobile device, or a policy. The upload is stored against the record named by resource, idType, and id. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
fORCEIPAUPLOADbooleannonullUploads the .ipa to Jamf Cloud Distribution Service instead of the Jamf Pro database. Only supported for Jamf Cloud customers and the `mobiledeviceapplicationsipa` resource.
idstringyesPath parameter 'id'.
idTypestringyesName is supported for all but the peripherals resource
resourcestringyesResource to attach the file to

Icon

ToolPlanAccessSummary
jamf_create_iconProDestructiveUploads an icon image to Jamf Pro.
jamf_get_iconFreeRead-onlyReads an icon record by ID.

[Jamf Pro] Uploads an icon image to Jamf Pro. Every Self Service item that points at the returned icon ID shows the new image. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Reads an icon record by ID. Icons are the images Self Service shows for policies, apps, and eBooks.

ParamTypeRequiredDefaultDescription
idstringyesid of the icon

Jamf Cloud Distribution Service

ToolPlanAccessSummary
jamf_create_jcds_filesProDestructiveCreates a temporary upload record and returns the credentials needed to upload a file to the Jamf Cloud Distribution Service.
jamf_create_jcds_refresh_inventoryProDestructiveRefreshes the inventory and status of uploads in Jamf Pro, which is what makes an uploaded file deployable.
jamf_create_jcds_renew_credentialsProDestructiveRenews the credentials needed to upload a file to the Jamf Cloud Distribution Service.
jamf_delete_jcds_filesProDestructiveDeletes a file from the Jamf Cloud Distribution Service by name.
jamf_get_jcds_filesFreeRead-onlyRetrieves a time limited download URL for one file in the Jamf Cloud Distribution Service.
jamf_list_jcds_filesFreeRead-onlyLists the files and file metadata held in the Jamf Cloud Distribution Service.

[Jamf Pro] Creates a temporary upload record and returns the credentials needed to upload a file to the Jamf Cloud Distribution Service. Those credentials grant write access to the distribution service, so treat the response as a secret. Jamf documents this surface as deprecated; jamf_upload_packages is the supported route. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

[Jamf Pro] Refreshes the inventory and status of uploads in Jamf Pro, which is what makes an uploaded file deployable. Without a fileName the whole inventory is refreshed, and Jamf allows that only once every 15 seconds. Jamf documents this surface as deprecated. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
fileNamestringnonullName of the file to check the availability of in JCDS. If available, the inventory and status will be updated in Jamf Pro. If no file is specified, it will force an immediate inventory refresh at a rate-limit of once every 15 seconds.

[Jamf Pro] Renews the credentials needed to upload a file to the Jamf Cloud Distribution Service. This mints fresh write credentials for the distribution service. Jamf documents this surface as deprecated; jamf_upload_packages is the supported route. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

[Jamf Pro] Deletes a file from the Jamf Cloud Distribution Service by name. The file is gone, and any package record that points at it can no longer be installed. Jamf documents this surface as deprecated. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
fileNamestringyesName of the file that will be deleted from the Jamf Cloud Distribution Service.

[Jamf Pro] Retrieves a time limited download URL for one file in the Jamf Cloud Distribution Service. Jamf documents this surface as deprecated; jamf_list_packages is the supported route. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
fileNamestringyesName of the file stored in the Jamf Cloud Distribution Service.

[Jamf Pro] Lists the files and file metadata held in the Jamf Cloud Distribution Service. Jamf documents this surface as deprecated; jamf_list_packages is the supported route. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

Jamf Package

ToolPlanAccessSummary
jamf_list_jamf_packageFreeRead-onlyLists the installer packages Jamf publishes for one of its own applications, such as Jamf Connect or Jamf Protect.

[Jamf Pro] Lists the installer packages Jamf publishes for one of its own applications, such as Jamf Connect or Jamf Protect. Name the application in the path.

ParamTypeRequiredDefaultDescription
applicationstringyesThe Jamf Application key. The only supported values are protect and connect.

Licensed Software (Classic API)

ToolPlanAccessSummary
jamf_classic_create_licensedsoftware_idProWriteCreates new licensed software by ID.
jamf_classic_delete_licensedsoftware_idProDestructiveDeletes licensed software by ID.
jamf_classic_delete_licensedsoftware_nameProDestructiveDeletes licensed software by name.
jamf_classic_get_licensedsoftware_idFreeRead-onlyFinds licensed software by ID.
jamf_classic_get_licensedsoftware_nameFreeRead-onlyFinds licensed software by name.
jamf_classic_list_licensedsoftwareFreeRead-onlyFinds all licensed software.
jamf_classic_update_licensedsoftware_idProDestructiveUpdates existing licensed software by ID.
jamf_classic_update_licensedsoftware_nameProDestructiveUpdates an existing licensed software by name.

[Jamf Pro] Creates new licensed software by ID. A licensed software record tracks how many licenses of a title the fleet holds and which computers use them. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes licensed software by ID. A licensed software record tracks how many licenses of a title the fleet holds and which computers use them. License tracking and every alert for this title stop. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes licensed software by name. A licensed software record tracks how many licenses of a title the fleet holds and which computers use them. License tracking and every alert for this title stop. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds licensed software by ID. A licensed software record tracks how many licenses of a title the fleet holds and which computers use them. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds licensed software by name. A licensed software record tracks how many licenses of a title the fleet holds and which computers use them. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all licensed software. A licensed software record tracks how many licenses of a title the fleet holds and which computers use them. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates existing licensed software by ID. A licensed software record tracks how many licenses of a title the fleet holds and which computers use them. The new license counts and matching rules apply at the next inventory update. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing licensed software by name. A licensed software record tracks how many licenses of a title the fleet holds and which computers use them. The new license counts and matching rules apply at the next inventory update. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Mac Applications (Classic API)

ToolPlanAccessSummary
jamf_classic_create_macapplications_idProDestructiveCreates a new Mac application record.
jamf_classic_delete_macapplications_idProDestructiveDeletes a mac application by ID.
jamf_classic_delete_macapplications_nameProDestructiveDeletes a mac application by name.
jamf_classic_get_macapplications_idFreeRead-onlyFinds mac applications by ID.
jamf_classic_get_macapplications_id_subsetFreeRead-onlyFinds a subset of date for a mac application by ID.
jamf_classic_get_macapplications_nameFreeRead-onlyFinds mac applications by name.
jamf_classic_get_macapplications_name_subsetFreeRead-onlyFinds a subset of data for mac applications by name.
jamf_classic_list_macapplicationsFreeRead-onlyFinds all mac applications.
jamf_classic_update_macapplications_idProDestructiveUpdates an existing mac application by ID.
jamf_classic_update_macapplications_nameProDestructiveUpdates an existing mac application by name.

[Jamf Pro] Creates a new Mac application record. Creating a scoped record installs the App Store app on every Mac in that scope, or offers it in Self Service. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a mac application by ID. A Mac application record deploys an App Store app to the Macs in its scope, through Self Service or automatic installation. The app is withdrawn from Self Service, and Macs that received it automatically can have it removed. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a mac application by name. A Mac application record deploys an App Store app to the Macs in its scope, through Self Service or automatic installation. The app is withdrawn from Self Service, and Macs that received it automatically can have it removed. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds mac applications by ID. A Mac application record deploys an App Store app to the Macs in its scope, through Self Service or automatic installation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds a subset of date for a mac application by ID. A Mac application record deploys an App Store app to the Macs in its scope, through Self Service or automatic installation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds mac applications by name. A Mac application record deploys an App Store app to the Macs in its scope, through Self Service or automatic installation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds a subset of data for mac applications by name. A Mac application record deploys an App Store app to the Macs in its scope, through Self Service or automatic installation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds all mac applications. A Mac application record deploys an App Store app to the Macs in its scope, through Self Service or automatic installation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing mac application by ID. A Mac application record deploys an App Store app to the Macs in its scope, through Self Service or automatic installation. The new scope and settings reach every affected Mac at the next check-in. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing mac application by name. A Mac application record deploys an App Store app to the Macs in its scope, through Self Service or automatic installation. The new scope and settings reach every affected Mac at the next check-in. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

macOS Configuration Profiles (Classic API)

ToolPlanAccessSummary
jamf_classic_create_osxconfigurationprofiles_idProDestructiveCreates a new macOS configuration profile.
jamf_classic_delete_osxconfigurationprofiles_idProDestructiveDeletes a OS X configuration profile by ID.
jamf_classic_delete_osxconfigurationprofiles_nameProDestructiveDeletes a OS X configuration profile by name.
jamf_classic_get_osxconfigurationprofiles_idFreeRead-onlyFinds OS X configuration profiles by ID.
jamf_classic_get_osxconfigurationprofiles_id_subsetFreeRead-onlyFinds a subset of data for an OS X configuration profile.
jamf_classic_get_osxconfigurationprofiles_nameFreeRead-onlyFinds OS X configuration profiles by name.
jamf_classic_get_osxconfigurationprofiles_name_subsetFreeRead-onlyFinds a subset of data for OS X configuration profiles by name.
jamf_classic_list_osxconfigurationprofilesFreeRead-onlyFinds all OS X configuration profiles.
jamf_classic_update_osxconfigurationprofiles_idProDestructiveUpdates an existing OS X configuration profile by ID.
jamf_classic_update_osxconfigurationprofiles_nameProDestructiveUpdates an existing OS X configuration profile by name.

[Jamf Pro] Creates a new macOS configuration profile. A configuration profile is an MDM payload, so creating a scoped profile installs it on every Mac in that scope at the next check-in. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a OS X configuration profile by ID. A macOS configuration profile is an MDM payload that Jamf Pro installs on the Macs in its scope. The profile is removed from every Mac that holds it, and the settings it enforced revert. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a OS X configuration profile by name. A macOS configuration profile is an MDM payload that Jamf Pro installs on the Macs in its scope. The profile is removed from every Mac that holds it, and the settings it enforced revert. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds OS X configuration profiles by ID. A macOS configuration profile is an MDM payload that Jamf Pro installs on the Macs in its scope. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds a subset of data for an OS X configuration profile. A macOS configuration profile is an MDM payload that Jamf Pro installs on the Macs in its scope. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds OS X configuration profiles by name. A macOS configuration profile is an MDM payload that Jamf Pro installs on the Macs in its scope. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds a subset of data for OS X configuration profiles by name. A macOS configuration profile is an MDM payload that Jamf Pro installs on the Macs in its scope. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds all OS X configuration profiles. A macOS configuration profile is an MDM payload that Jamf Pro installs on the Macs in its scope. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing OS X configuration profile by ID. A macOS configuration profile is an MDM payload that Jamf Pro installs on the Macs in its scope. The revised profile is reinstalled on every Mac in scope at the next check-in. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing OS X configuration profile by name. A macOS configuration profile is an MDM payload that Jamf Pro installs on the Macs in its scope. The revised profile is reinstalled on every Mac in scope at the next check-in. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Packages

ToolPlanAccessSummary
jamf_create_packagesProWriteCreate package.
jamf_create_packages_historyProWriteAdd specified Package history object notes.
jamf_create_packages_manifestProWriteAttaches a manifest to a package record.
jamf_delete_multiple_packagesProDestructiveDeletes several package records in one call.
jamf_delete_packagesProDestructiveRemove specified package.
jamf_delete_packages_manifestProDestructiveDeletes the manifest attached to a package record.
jamf_export_packagesFreeRead-onlyExports the package collection in the format you ask for.
jamf_export_packages_historyFreeRead-onlyExports the history of one package record in the format you ask for.
jamf_get_packagesFreeRead-onlyGet specified Package object.
jamf_list_packagesFreeRead-onlyRetrieve Packages.
jamf_list_packages_historyFreeRead-onlyGet specified Package History object.
jamf_update_packagesProDestructiveUpdate specified package object.
jamf_upload_packagesProDestructiveUploads the installer file for an existing package record.

[Jamf Pro] Create package. A package record is the metadata for an installer file. Upload the file with jamf_upload_packages, then install it with a policy or with jamf_create_deploy_package. jamf_classic_list_packages reaches the same records through the Classic API. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Add specified Package history object notes. A package record is the metadata for an installer file. Upload the file with jamf_upload_packages, then install it with a policy or with jamf_create_deploy_package. jamf_classic_list_packages reaches the same records through the Classic API. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesInstance ID of package history

[Jamf Pro] Attaches a manifest to a package record. A manifest describes an App Store style install and is additive to the package. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesId of the package the manifest should be assigned to

[Jamf Pro] Deletes several package records in one call. Deletion is permanent, and every policy that installs one of these packages stops working. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Remove specified package. A package record is the metadata for an installer file. Upload the file with jamf_upload_packages, then install it with a policy or with jamf_create_deploy_package. jamf_classic_list_packages reaches the same records through the Classic API. Every policy that installs this package stops working; the installer file on the distribution point is not removed. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesInstance ID of package

[Jamf Pro] Deletes the manifest attached to a package record. Any deployment that relies on that manifest, such as an App Store style install, stops working. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesId of the package to delete manifest from

[Jamf Pro] Exports the package collection in the format you ask for. Send the column list and format in the request body; this reads data and changes nothing. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
exportFieldsstringnonullExport fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username
exportLabelsstringnonullExport labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username
fieldsJsonstringyesJSON object request body.
filterstringnonullFilters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.

[Jamf Pro] Exports the history of one package record in the format you ask for. Send the column list and format in the request body; this reads data and changes nothing. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
exportFieldsstringnonullExport fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username
exportLabelsstringnonullExport labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username
fieldsJsonstringyesJSON object request body.
filterstringnonullFilters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.
idstringyesInstance ID of package history note
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.

[Jamf Pro] Get specified Package object. A package record is the metadata for an installer file. Upload the file with jamf_upload_packages, then install it with a policy or with jamf_create_deploy_package. jamf_classic_list_packages reaches the same records through the Classic API.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of package

[Jamf Pro] Retrieve Packages. A package record is the metadata for an installer file. Upload the file with jamf_upload_packages, then install it with a policy or with jamf_create_deploy_package. jamf_classic_list_packages reaches the same records through the Classic API. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullFilters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Fields allowed in the query: id, fileName, packageName, categoryId, info, notes, manifestFileName, cloudTransferStatus. Default filter is an empty query and returns all results from the requested page.
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.

[Jamf Pro] Get specified Package History object. A package record is the metadata for an installer file. Upload the file with jamf_upload_packages, then install it with a policy or with jamf_create_deploy_package. jamf_classic_list_packages reaches the same records through the Classic API. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullFilters results. Use RSQL format for query. Allows for many fields, including ID, name, etc. Can be combined with paging and sorting. Default filter is an empty query and returns all results from the requested page.
idstringyesInstance ID of package history
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorts results by one or more criteria, following the format property:asc/desc. Default sort is ID:asc. If using multiple criteria, separate with commas.

[Jamf Pro] Update specified package object. A package record is the metadata for an installer file. Upload the file with jamf_upload_packages, then install it with a policy or with jamf_create_deploy_package. jamf_classic_list_packages reaches the same records through the Classic API. Policies that install this package use the new values the next time they run. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesInstance ID of package

[Jamf Pro] Uploads the installer file for an existing package record. The file becomes available on the distribution point, and every policy that installs this package starts serving the new file. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of package

Packages (Classic API)

ToolPlanAccessSummary
jamf_classic_create_packages_idProWriteCreates a new package by ID.
jamf_classic_delete_packages_idProDestructiveDeletes a package by ID.
jamf_classic_delete_packages_nameProDestructiveDeletes a package by name.
jamf_classic_get_packages_idFreeRead-onlyFinds packages by ID.
jamf_classic_get_packages_nameFreeRead-onlyFinds packages by name.
jamf_classic_list_packagesFreeRead-onlyFinds all packages.
jamf_classic_update_packages_idProDestructiveUpdates an existing package by ID.
jamf_classic_update_packages_nameProDestructiveUpdates an existing package by name.

[Jamf Pro] Creates a new package by ID. A package record is the metadata for an installer file; a policy or jamf_create_deploy_package is what installs it. This is the Classic API surface; jamf_list_packages reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a package by ID. A package record is the metadata for an installer file; a policy or jamf_create_deploy_package is what installs it. This is the Classic API surface; jamf_list_packages reaches the same records through the newer Jamf Pro API. Every policy that installs this package stops working; the installer file on the distribution point is not removed. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a package by name. A package record is the metadata for an installer file; a policy or jamf_create_deploy_package is what installs it. This is the Classic API surface; jamf_list_packages reaches the same records through the newer Jamf Pro API. Every policy that installs this package stops working; the installer file on the distribution point is not removed. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds packages by ID. A package record is the metadata for an installer file; a policy or jamf_create_deploy_package is what installs it. This is the Classic API surface; jamf_list_packages reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds packages by name. A package record is the metadata for an installer file; a policy or jamf_create_deploy_package is what installs it. This is the Classic API surface; jamf_list_packages reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all packages. A package record is the metadata for an installer file; a policy or jamf_create_deploy_package is what installs it. This is the Classic API surface; jamf_list_packages reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing package by ID. A package record is the metadata for an installer file; a policy or jamf_create_deploy_package is what installs it. This is the Classic API surface; jamf_list_packages reaches the same records through the newer Jamf Pro API. Policies that install this package use the new values the next time they run. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing package by name. A package record is the metadata for an installer file; a policy or jamf_create_deploy_package is what installs it. This is the Classic API surface; jamf_list_packages reaches the same records through the newer Jamf Pro API. Policies that install this package use the new values the next time they run. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Policies (Classic API)

ToolPlanAccessSummary
jamf_classic_create_policies_idProDestructiveCreates a new policy.
jamf_classic_delete_policies_idProDestructiveDeletes a policy by ID.
jamf_classic_delete_policies_nameProDestructiveDeletes a policy by name.
jamf_classic_get_policies_categoryFreeRead-onlyFinds all policies by category.
jamf_classic_get_policies_createdbyFreeRead-onlyFinds all policies by type.
jamf_classic_get_policies_idFreeRead-onlyFinds policies by ID.
jamf_classic_get_policies_id_subsetFreeRead-onlyFinds a subset of data for a policy.
jamf_classic_get_policies_nameFreeRead-onlyFinds policies by name.
jamf_classic_get_policies_name_subsetFreeRead-onlyFinds a subset of data for policies by name.
jamf_classic_list_policiesFreeRead-onlyFinds all policies.
jamf_classic_update_policies_idProDestructiveUpdates an existing policy by ID.
jamf_classic_update_policies_nameProDestructiveUpdates an existing policy by name.

[Jamf Pro] Creates a new policy. Creating a scoped policy arms it, and the Macs in its scope run it the next time one of its triggers fires. A policy can install packages and run scripts as root. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a policy by ID. A policy runs packages, scripts, and maintenance tasks on the Macs in its scope, at the triggers it defines. The policy stops running, and any pending run on a scoped Mac is abandoned. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a policy by name. A policy runs packages, scripts, and maintenance tasks on the Macs in its scope, at the triggers it defines. The policy stops running, and any pending run on a scoped Mac is abandoned. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds all policies by category. A policy runs packages, scripts, and maintenance tasks on the Macs in its scope, at the triggers it defines. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
categorystringyesCategory to filter by

[Jamf Pro] Finds all policies by type. A policy runs packages, scripts, and maintenance tasks on the Macs in its scope, at the triggers it defines. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
createdBystringyesType to filter by

[Jamf Pro] Finds policies by ID. A policy runs packages, scripts, and maintenance tasks on the Macs in its scope, at the triggers it defines. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds a subset of data for a policy. A policy runs packages, scripts, and maintenance tasks on the Macs in its scope, at the triggers it defines. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds policies by name. A policy runs packages, scripts, and maintenance tasks on the Macs in its scope, at the triggers it defines. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds a subset of data for policies by name. A policy runs packages, scripts, and maintenance tasks on the Macs in its scope, at the triggers it defines. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds all policies. A policy runs packages, scripts, and maintenance tasks on the Macs in its scope, at the triggers it defines. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing policy by ID. A policy runs packages, scripts, and maintenance tasks on the Macs in its scope, at the triggers it defines. Macs in scope run the revised policy the next time one of its triggers fires, and a policy can install packages and run scripts as root. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing policy by name. A policy runs packages, scripts, and maintenance tasks on the Macs in its scope, at the triggers it defines. Macs in scope run the revised policy the next time one of its triggers fires, and a policy can install packages and run scripts as root. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Policy Properties

ToolPlanAccessSummary
jamf_list_policy_propertiesFreeRead-onlyGet Policy Properties object.
jamf_update_policy_propertiesProDestructiveUpdates the Jamf Pro wide policy property defaults.

[Jamf Pro] Get Policy Properties object. Policy properties are the Jamf Pro wide defaults that every policy on the server inherits.

[Jamf Pro] Updates the Jamf Pro wide policy property defaults. This changes a default that every policy on the server inherits. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Printers (Classic API)

ToolPlanAccessSummary
jamf_classic_create_printers_idProWriteCreates a new printer by ID.
jamf_classic_delete_printers_idProDestructiveDeletes a printer by ID.
jamf_classic_delete_printers_nameProDestructiveDeletes a printer by name.
jamf_classic_get_printers_idFreeRead-onlyFinds printers by ID.
jamf_classic_get_printers_nameFreeRead-onlyFinds printers by name.
jamf_classic_list_printersFreeRead-onlyFinds all printers.
jamf_classic_update_printers_idProDestructiveUpdates an existing printer by ID.
jamf_classic_update_printers_nameProDestructiveUpdates an existing printer by name.

[Jamf Pro] Creates a new printer by ID. A printer record defines a print queue that a policy can map on the Macs in its scope. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a printer by ID. A printer record defines a print queue that a policy can map on the Macs in its scope. Every policy that maps this printer stops working. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a printer by name. A printer record defines a print queue that a policy can map on the Macs in its scope. Every policy that maps this printer stops working. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds printers by ID. A printer record defines a print queue that a policy can map on the Macs in its scope. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds printers by name. A printer record defines a print queue that a policy can map on the Macs in its scope. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all printers. A printer record defines a print queue that a policy can map on the Macs in its scope. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing printer by ID. A printer record defines a print queue that a policy can map on the Macs in its scope. Policies that map this printer use the new queue settings the next time they run. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing printer by name. A printer record defines a print queue that a policy can map on the Macs in its scope. Policies that map this printer use the new queue settings the next time they run. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Restricted Software (Classic API)

ToolPlanAccessSummary
jamf_classic_create_restrictedsoftware_idProDestructiveCreates a new restricted software record.
jamf_classic_delete_restrictedsoftware_idProDestructiveDeletes a restricted software by ID.
jamf_classic_delete_restrictedsoftware_nameProDestructiveDeletes a restricted software by name.
jamf_classic_get_restrictedsoftware_idFreeRead-onlyFinds restricted software by ID.
jamf_classic_get_restrictedsoftware_nameFreeRead-onlyFinds restricted software by name.
jamf_classic_list_restrictedsoftwareFreeRead-onlyFinds all restricted software.
jamf_classic_update_restrictedsoftware_idProDestructiveUpdates an existing restricted software by ID.
jamf_classic_update_restrictedsoftware_nameProDestructiveUpdates an existing restricted software by name.

[Jamf Pro] Creates a new restricted software record. Creating a scoped record starts blocking the named process on every Mac in that scope, and can delete the application it belongs to. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a restricted software by ID. A restricted software record blocks a named process on the Macs in its scope, and can delete the application it belongs to. The named process is no longer blocked on any Mac. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a restricted software by name. A restricted software record blocks a named process on the Macs in its scope, and can delete the application it belongs to. The named process is no longer blocked on any Mac. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds restricted software by ID. A restricted software record blocks a named process on the Macs in its scope, and can delete the application it belongs to. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds restricted software by name. A restricted software record blocks a named process on the Macs in its scope, and can delete the application it belongs to. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all restricted software. A restricted software record blocks a named process on the Macs in its scope, and can delete the application it belongs to. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing restricted software by ID. A restricted software record blocks a named process on the Macs in its scope, and can delete the application it belongs to. The revised restriction takes effect on every Mac in its scope at the next check-in. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing restricted software by name. A restricted software record blocks a named process on the Macs in its scope, and can delete the application it belongs to. The revised restriction takes effect on every Mac in its scope at the next check-in. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Scripts

ToolPlanAccessSummary
jamf_create_scriptsProWriteCreate a Script.
jamf_create_scripts_historyProWriteAdd specified Script history object notes.
jamf_delete_scriptsProDestructiveDelete a Script at the specified id.
jamf_get_scriptsFreeRead-onlyRetrieve a full script object.
jamf_list_scriptsFreeRead-onlySearch for sorted and paged Scripts.
jamf_list_scripts_downloadFreeRead-onlyDownloads the contents of a script as a text file.
jamf_list_scripts_historyFreeRead-onlyGet specified Script history object.
jamf_update_scriptsProDestructiveReplace the script at the id with the supplied information.

[Jamf Pro] Create a Script. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. jamf_classic_list_scripts reaches the same records through the Classic API. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Add specified Script history object notes. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. jamf_classic_list_scripts reaches the same records through the Classic API. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of script history record

[Jamf Pro] Delete a Script at the specified id. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. jamf_classic_list_scripts reaches the same records through the Classic API. Every policy that runs this script stops working. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesScript object identifier

[Jamf Pro] Retrieve a full script object. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. jamf_classic_list_scripts reaches the same records through the Classic API.

ParamTypeRequiredDefaultDescription
idstringyesScript object identifier

[Jamf Pro] Search for sorted and paged Scripts. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. jamf_classic_list_scripts reaches the same records through the Classic API. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter scripts collection. Default search is empty query - returning all results for the requested page. Fields allowed in the query: `id`, `name`, `info`, `notes`, `priority`, `categoryId`, `categoryName`, `parameter4` up to `parameter11`, `osRequirements`, `scriptContents`. This param can be combined with paging and sorting. Example: filter=categoryName=="Category" and name=="script name"
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the query: `id`, `name`, `info`, `notes`, `priority`, `categoryId`, `categoryName`, `parameter4` up to `parameter11`, `osRequirements`, `scriptContents`. Example: sort=date:desc,name:asc

[Jamf Pro] Downloads the contents of a script as a text file. This returns the shell code the script runs as root, so treat the response as sensitive.

ParamTypeRequiredDefaultDescription
idstringyesid of the script to be downloaded

[Jamf Pro] Get specified Script history object. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. jamf_classic_list_scripts reaches the same records through the Classic API. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15
idstringyesid of script history record
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Replace the script at the id with the supplied information. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. jamf_classic_list_scripts reaches the same records through the Classic API. Every policy that runs this script executes the new code as root the next time it runs. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesScript object identifier

Scripts (Classic API)

ToolPlanAccessSummary
jamf_classic_create_scripts_idProWriteCreates a new script by ID.
jamf_classic_delete_scripts_idProDestructiveDeletes a script by ID.
jamf_classic_delete_scripts_nameProDestructiveDeletes a script by name.
jamf_classic_get_scripts_idFreeRead-onlyFinds scripts by ID.
jamf_classic_get_scripts_nameFreeRead-onlyFinds scripts by name.
jamf_classic_list_scriptsFreeRead-onlyFinds all scripts.
jamf_classic_update_scripts_idProDestructiveUpdates an existing script by ID.
jamf_classic_update_scripts_nameProDestructiveUpdates an existing script by name.

[Jamf Pro] Creates a new script by ID. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. This is the Classic API surface; jamf_list_scripts reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a script by ID. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. This is the Classic API surface; jamf_list_scripts reaches the same records through the newer Jamf Pro API. Every policy that runs this script stops working. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a script by name. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. This is the Classic API surface; jamf_list_scripts reaches the same records through the newer Jamf Pro API. Every policy that runs this script stops working. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds scripts by ID. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. This is the Classic API surface; jamf_list_scripts reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds scripts by name. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. This is the Classic API surface; jamf_list_scripts reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all scripts. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. This is the Classic API surface; jamf_list_scripts reaches the same records through the newer Jamf Pro API. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing script by ID. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. This is the Classic API surface; jamf_list_scripts reaches the same records through the newer Jamf Pro API. Every policy that runs this script executes the new code as root the next time it runs. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing script by name. A script record holds shell code that a policy runs as root on the Macs in its scope; creating a script does not run it. This is the Classic API surface; jamf_list_scripts reaches the same records through the newer Jamf Pro API. Every policy that runs this script executes the new code as root the next time it runs. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Self Service

ToolPlanAccessSummary
jamf_create_self_service_branding_imagesProDestructiveUploads a branding image for use in a Self Service branding configuration.
jamf_create_self_service_branding_iosProWriteCreate a Self Service iOS branding configuration with the supplied.
jamf_create_self_service_branding_macosProWriteCreate a Self Service macOS branding configuration with the supplied.
jamf_create_self_service_settings_historyProWriteAdd Self Service settings history notes.
jamf_delete_self_service_branding_iosProDestructiveDelete the Self Service iOS branding configuration indicated by the provided id.
jamf_delete_self_service_branding_macosProDestructiveDelete the Self Service macOS branding configuration indicated by the provided id.
jamf_get_self_service_branding_iosFreeRead-onlyRead a single Self Service iOS branding configuration indicated by the provided id.
jamf_get_self_service_branding_macosFreeRead-onlyRead a single Self Service macOS branding configuration indicated by the provided id.
jamf_list_self_service_branding_iosFreeRead-onlySearch for sorted and paged iOS branding configurations.
jamf_list_self_service_branding_macosFreeRead-onlySearch for sorted and paged macOS branding configurations.
jamf_list_self_service_settingsFreeRead-onlyGet an object representation of Self Service settings.
jamf_list_self_service_settings_historyFreeRead-onlyGet a page of Self Service settings history.
jamf_update_self_service_branding_iosProDestructiveUpdate a Self Service iOS branding configuration with the supplied details.
jamf_update_self_service_branding_macosProDestructiveUpdate a Self Service macOS branding configuration with the supplied details.
jamf_update_self_service_settingsProDestructivePut an object representation of Self Service settings.

[Jamf Pro] Uploads a branding image for use in a Self Service branding configuration. Every Self Service user assigned that configuration sees the new image. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Create a Self Service iOS branding configuration with the supplied. Self Service is the Jamf app that end users open to install approved software and run approved policies. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Create a Self Service macOS branding configuration with the supplied. Self Service is the Jamf app that end users open to install approved software and run approved policies. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Add Self Service settings history notes. Self Service is the Jamf app that end users open to install approved software and run approved policies. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete the Self Service iOS branding configuration indicated by the provided id. Self Service is the Jamf app that end users open to install approved software and run approved policies. Self Service reverts to the default appearance for every device that used this branding. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesid of iOS branding configuration

[Jamf Pro] Delete the Self Service macOS branding configuration indicated by the provided id. Self Service is the Jamf app that end users open to install approved software and run approved policies. Self Service reverts to the default appearance for every device that used this branding. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesid of macOS branding configuration

[Jamf Pro] Read a single Self Service iOS branding configuration indicated by the provided id. Self Service is the Jamf app that end users open to install approved software and run approved policies.

ParamTypeRequiredDefaultDescription
idstringyesid of iOS branding configuration

[Jamf Pro] Read a single Self Service macOS branding configuration indicated by the provided id. Self Service is the Jamf app that end users open to install approved software and run approved policies.

ParamTypeRequiredDefaultDescription
idstringyesid of macOS branding configuration

[Jamf Pro] Search for sorted and paged iOS branding configurations. Self Service is the Jamf app that end users open to install approved software and run approved policies. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,brandingName:asc

[Jamf Pro] Search for sorted and paged macOS branding configurations. Self Service is the Jamf app that end users open to install approved software and run approved policies. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,brandingName:asc

[Jamf Pro] Get an object representation of Self Service settings. Self Service is the Jamf app that end users open to install approved software and run approved policies.

[Jamf Pro] Get a page of Self Service settings history. Self Service is the Jamf app that end users open to install approved software and run approved policies. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter results. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: status, updated, version This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is not duplicated for each sort criterion, e.g., ...&sort=name:asc,date:desc. Fields that can be sorted: status, updated

[Jamf Pro] Update a Self Service iOS branding configuration with the supplied details. Self Service is the Jamf app that end users open to install approved software and run approved policies. Every Self Service user sees the change. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesid of iOS branding configuration

[Jamf Pro] Update a Self Service macOS branding configuration with the supplied details. Self Service is the Jamf app that end users open to install approved software and run approved policies. Every Self Service user sees the change. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesid of macOS branding configuration

[Jamf Pro] Put an object representation of Self Service settings. Self Service is the Jamf app that end users open to install approved software and run approved policies. Every Self Service user sees the change. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Self Service Plus

ToolPlanAccessSummary
jamf_list_self_service_plus_feature_toggle_enabledFreeRead-onlyReports whether the Self Service Plus feature toggle is enabled on this Jamf Pro server.
jamf_list_self_service_plus_settingsFreeRead-onlyGet Self Service Plus settings.
jamf_update_self_service_plus_settingsProDestructiveSave Self Service Plus settings.

[Jamf Pro] Reports whether the Self Service Plus feature toggle is enabled on this Jamf Pro server. Check this before you read or write the Self Service Plus settings with jamf_list_self_service_plus_settings.

[Jamf Pro] Get Self Service Plus settings. Self Service Plus is the newer Self Service experience, controlled by its own feature toggle and settings.

[Jamf Pro] Save Self Service Plus settings. Self Service Plus is the newer Self Service experience, controlled by its own feature toggle and settings. Every Self Service Plus user sees the change. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Software Update Servers (Classic API)

ToolPlanAccessSummary
jamf_classic_create_softwareupdateservers_idProWriteCreates a new software update server by ID.
jamf_classic_delete_softwareupdateservers_idProDestructiveDeletes a software update server by ID.
jamf_classic_delete_softwareupdateservers_nameProDestructiveDeletes a software update server by name.
jamf_classic_get_softwareupdateservers_idFreeRead-onlyFinds software update servers by ID.
jamf_classic_get_softwareupdateservers_nameFreeRead-onlyFinds software update servers by name.
jamf_classic_list_softwareupdateserversFreeRead-onlyFinds all software update servers.
jamf_classic_update_softwareupdateservers_idProDestructiveUpdates an existing software update server by ID.
jamf_classic_update_softwareupdateservers_nameProDestructiveUpdates an existing software update server by name.

[Jamf Pro] Creates a new software update server by ID. A software update server record points the Macs in its scope at an internal Apple software update server. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a software update server by ID. A software update server record points the Macs in its scope at an internal Apple software update server. Macs that used this server fall back to the public Apple software update servers. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a software update server by name. A software update server record points the Macs in its scope at an internal Apple software update server. Macs that used this server fall back to the public Apple software update servers. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds software update servers by ID. A software update server record points the Macs in its scope at an internal Apple software update server. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds software update servers by name. A software update server record points the Macs in its scope at an internal Apple software update server. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all software update servers. A software update server record points the Macs in its scope at an internal Apple software update server. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates an existing software update server by ID. A software update server record points the Macs in its scope at an internal Apple software update server. Macs that use this server follow the new address at the next check-in. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates an existing software update server by name. A software update server record points the Macs in its scope at an internal Apple software update server. Macs that use this server follow the new address at the next check-in. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Apple Push Notification Status

ToolPlanAccessSummary
jamf_create_apns_client_push_status_enable_all_clientsProDestructiveEnable push notifications for all clients.
jamf_create_apns_client_push_status_enable_clientProDestructiveEnable push notifications for a single client.
jamf_list_apns_client_push_statusFreeRead-onlySearch for clients with push notifications disabled.
jamf_list_apns_client_push_status_enable_all_clients_statusFreeRead-onlyGet status of enable all clients request.

[Jamf Pro] Enable push notifications for all clients. DESTRUCTIVE: this turns on Apple push notifications for every client in Jamf Pro at once, changing how the whole fleet is contacted. No single call reverses it. Read the current state with jamf_list_apns_client_push_status first.

[Jamf Pro] Enable push notifications for a single client. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this turns on Apple push notifications for one client and changes how Jamf Pro contacts it. Read the current state with jamf_list_apns_client_push_status first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Search for clients with push notifications disabled. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Shows which clients have Apple push notifications enabled. Turn one on with jamf_create_apns_client_push_status_enable_client.

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter results. Fields allowed in the query: deviceType, disabledAt, managementId. This param can be combined with paging and sorting. Example: filter=deviceType=="MOBILE_DEVICE" Example: filter=disabledAt>2024-11-01T00:00:00Z Example: filter=deviceType=="COMPUTER";disabledAt>2024-01-01T00:00:00Z
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported. Sortable fields: pushDisabledTime, deviceType, managementId

Check In

ToolPlanAccessSummary
jamf_create_check_in_historyProWriteAdd a Note to Client Check-In History.
jamf_list_check_inFreeRead-onlyGet Client Check-In settings.
jamf_list_check_in_historyFreeRead-onlyGet Client Check-In history object.
jamf_update_check_inProDestructiveUpdate Client Check-In object.

[Jamf Pro] Add a Note to Client Check-In History. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Get Client Check-In settings. Returns the client check-in configuration, which sets how often every managed device contacts Jamf Pro. Change it with jamf_update_check_in, which replaces the whole object.

[Jamf Pro] Get Client Check-In history object. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,username:asc

[Jamf Pro] Update Client Check-In object. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces the whole client check-in configuration, so every field you omit is reset to its default. Check-in frequency governs how often every managed device contacts Jamf Pro. Read the current object with jamf_list_check_in and send it back with only your change applied.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Command Flush (Classic API)

ToolPlanAccessSummary
jamf_classic_delete_commandflushProDestructiveFlushes commands based on information specified in an XML file.
jamf_classic_delete_commandflush_id_statusProDestructiveFlushes commands for devices.

[Jamf Pro] Flushes commands based on information specified in an XML file. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this cancels queued MDM commands for the devices named in your XML document. A flushed command is discarded, not retried, so pending wipes, locks, profile installs and inventory requests never reach the device.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.

[Jamf Pro] Flushes commands for devices. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this cancels queued MDM commands for one device or group. A flushed command is discarded, not retried, so pending wipes, locks, profile installs and inventory requests never reach the device.

ParamTypeRequiredDefaultDescription
idstringyesID of device to be flushed
idtypestringyesType of device to be flushed
statusstringyesCommand status to be flushed

Declarative Device Management

ToolPlanAccessSummary
jamf_get_ddm_status_itemsFreeRead-onlyRetrieve a Status Item from the latest Status Report for a device.
jamf_list_ddm_status_itemsFreeRead-onlyRetrieve the Status Items from the latest Status Report for a device.
jamf_sync_ddmProDestructiveForce a device DDM sync.
ParamTypeRequiredDefaultDescription
clientManagementIdstringyesclient management id of the target device.
keystringyesthe status item key to retrieve.

[Jamf Pro] Retrieve the Status Items from the latest Status Report for a device. Lists declarative device management status items reported by devices. Force a device to re-report with jamf_sync_ddm.

ParamTypeRequiredDefaultDescription
clientManagementIdstringyesclient management id of the target device.

[Jamf Pro] Force a device DDM sync. DESTRUCTIVE: this forces a declarative device management sync on the named device, which re-evaluates and reapplies its declarations immediately. Confirm the client management id before you run it.

ParamTypeRequiredDefaultDescription
clientManagementIdstringyesThe client management id of the target device.

Declarative Device Management Declarations

ToolPlanAccessSummary
jamf_get_dss_declarationsFreeRead-onlyRetrieve an existing declaration.
ParamTypeRequiredDefaultDescription
declarationIdstringyesDeclaration UUID

Device Communication Settings

ToolPlanAccessSummary
jamf_create_device_communication_settings_historyProWriteAdd Device Communication Settings history notes.
jamf_list_device_communication_settingsFreeRead-onlyRetrieves all settings for device communication.
jamf_list_device_communication_settings_historyFreeRead-onlyGet Device Communication settings history.
jamf_update_device_communication_settingsProDestructiveUpdate device communication settings.

[Jamf Pro] Add Device Communication Settings history notes. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Get Device Communication settings history. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Update device communication settings. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces the whole device communication settings object, so every field you omit is reset. These settings govern how the entire fleet talks to Jamf Pro. Read the current object with jamf_list_device_communication_settings first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Device Enrollments

ToolPlanAccessSummary
jamf_create_device_enrollments_historyProWriteAdd Device Enrollment history object notes.
jamf_create_device_enrollments_upload_tokenProDestructiveCreate a Device Enrollment Instance with the supplied Token.
jamf_delete_device_enrollmentsProDestructiveDelete a Device Enrollment Instance with the supplied id.
jamf_disown_device_enrollmentsProDestructiveDisown devices from the given Device Enrollment Instance.
jamf_get_device_enrollmentsFreeRead-onlyRetrieve a Device Enrollment Instance with the supplied id.
jamf_list_device_enrollmentsFreeRead-onlyRead all sorted and paged Device Enrollment instances.
jamf_list_device_enrollments_devicesFreeRead-onlyRetrieve a list of Devices assigned to the supplied id.
jamf_list_device_enrollments_historyFreeRead-onlyGet sorted and paged Device Enrollment history objects.
jamf_list_device_enrollments_syncsFreeRead-onlyGet all instance sync states for all Device Enrollment Instances.
jamf_list_device_enrollments_syncs_idFreeRead-onlyGet all instance sync states for a single Device Enrollment Instance.
jamf_list_device_enrollments_syncs_latestFreeRead-onlyGet the latest sync state for a single Device Enrollment Instance.
jamf_update_device_enrollmentsProDestructiveUpdate a Device Enrollment Instance with the supplied id.
jamf_update_device_enrollments_upload_tokenProDestructiveUpdate a Device Enrollment Instance with the supplied Token.

[Jamf Pro] Add Device Enrollment history object notes. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesDevice Enrollment Instance identifier

[Jamf Pro] Create a Device Enrollment Instance with the supplied Token. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this creates an Automated Device Enrollment instance from an Apple Business Manager or Apple School Manager server token. The token binds this Jamf Pro server to that Apple account, so uploading the wrong one links the wrong device estate.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete a Device Enrollment Instance with the supplied id. DESTRUCTIVE: this permanently deletes an Automated Device Enrollment instance. Devices assigned to it lose their enrollment assignment and no longer enroll automatically. List the affected devices with jamf_list_device_enrollments_devices first.

ParamTypeRequiredDefaultDescription
idstringyesDevice Enrollment Instance identifier

[Jamf Pro] Disown devices from the given Device Enrollment Instance. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this disowns devices from the Automated Device Enrollment instance. Disowning is irreversible in Apple Business Manager and permanently removes those devices from automated enrollment.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesDevice Enrollment Instance identifier

[Jamf Pro] Retrieve a Device Enrollment Instance with the supplied id. Returns one Automated Device Enrollment instance. Read it before jamf_update_device_enrollments, which replaces the whole record.

ParamTypeRequiredDefaultDescription
idstringyesDevice Enrollment Instance identifier

[Jamf Pro] Read all sorted and paged Device Enrollment instances. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. Lists the Automated Device Enrollment instances, one per Apple Business Manager or Apple School Manager server token. Use jamf_list_device_enrollments_devices for the devices assigned to one, and jamf_list_device_enrollments_syncs_latest to check whether the last Apple sync succeeded.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Retrieve a list of Devices assigned to the supplied id. Lists the devices Apple has assigned to this Automated Device Enrollment instance. These are the devices jamf_disown_device_enrollments would irreversibly release.

ParamTypeRequiredDefaultDescription
idstringyesDevice Enrollment Instance identifier

[Jamf Pro] Get sorted and paged Device Enrollment history objects. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default search is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: search=username!=admin and details==disabled and date<2019-12-15
idstringyesDevice Enrollment Instance identifier
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property,asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is duplicated for each sort criterion, e.g., ...&sort=name%2Casc&sort=date%2Cdesc
ParamTypeRequiredDefaultDescription
idstringyesDevice Enrollment Instance identifier

[Jamf Pro] Get the latest sync state for a single Device Enrollment Instance. Returns the most recent Apple sync for the instance. Use it to tell a stale device list from a failed sync before you investigate an enrollment problem.

ParamTypeRequiredDefaultDescription
idstringyesDevice Enrollment Instance identifier

[Jamf Pro] Update a Device Enrollment Instance with the supplied id. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces the Automated Device Enrollment instance, so every field you omit is reset. Read the current instance with jamf_get_device_enrollments first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesDevice Enrollment Instance identifier

[Jamf Pro] Update a Device Enrollment Instance with the supplied Token. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces the Apple server token on an existing Automated Device Enrollment instance. A wrong or stale token breaks the Apple sync for every device assigned to that instance.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesDevice Enrollment Instance identifier

Enrollment

ToolPlanAccessSummary
jamf_create_enrollment_access_groupsProDestructiveAdd the configured LDAP group for User-Initiated Enrollment.
jamf_create_enrollment_access_managementProDestructiveConfigure Access Management settings.
jamf_create_enrollment_historyProWriteAdd Enrollment history object notes.
jamf_delete_enrollment_access_groupsProDestructiveDelete an LDAP group's access to user initiated Enrollment.
jamf_delete_enrollment_languagesProDestructiveDelete the Enrollment messaging for a language.
jamf_delete_multiple_enrollment_languagesProDestructiveDelete multiple configured languages from User-Initiated Enrollment settings.
jamf_export_enrollment_historyFreeRead-onlyExport enrollment history collection.
jamf_get_enrollment_access_groupsFreeRead-onlyRetrieve the configured LDAP groups configured for User-Initiated Enrollment.
jamf_get_enrollment_languagesFreeRead-onlyRetrieve the Enrollment messaging for a language.
jamf_list_enrollmentFreeRead-onlyGet Enrollment object and Re-enrollment settings.
jamf_list_enrollment_access_groupsFreeRead-onlyRetrieve the configured LDAP groups configured for User-Initiated Enrollment.
jamf_list_enrollment_access_managementFreeRead-onlyGet Access Management settings.
jamf_list_enrollment_filtered_language_codesFreeRead-onlyRetrieve the list of languages and corresponding ISO 639-1 Codes but only those not already added to Enrollment.
jamf_list_enrollment_historyFreeRead-onlyGet sorted and paged Enrollment history object.
jamf_list_enrollment_language_codesFreeRead-onlyRetrieve the list of languages and corresponding ISO 639-1 Codes.
jamf_list_enrollment_languagesFreeRead-onlyGet an array of the language codes that have Enrollment messaging.
jamf_update_enrollmentProDestructiveUpdate Enrollment object.
jamf_update_enrollment_access_groupsProDestructiveModify the configured LDAP groups configured for User-Initiated Enrollment.
jamf_update_enrollment_languagesProDestructiveEdit Enrollment messaging for a language.

[Jamf Pro] Add the configured LDAP group for User-Initiated Enrollment. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this grants an LDAP group access to user-initiated enrollment, so every member of that group can enroll devices into management. It widens who may add devices to the estate. Review the result with jamf_list_enrollment_access_groups.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Configure Access Management settings. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this writes the access management settings that govern which accounts may enroll devices, replacing the stored configuration rather than merging into it. Read the current settings with jamf_list_enrollment_access_management first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Add Enrollment history object notes. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete an LDAP group's access to user initiated Enrollment. DESTRUCTIVE: this removes the access an LDAP group has to user-initiated enrollment. Members of that group can no longer enroll devices.

ParamTypeRequiredDefaultDescription
idstringyesAutogenerated Access Group ID.

[Jamf Pro] Delete the Enrollment messaging for a language. DESTRUCTIVE: this permanently deletes the enrollment messaging for one language. Users enrolling in that language fall back to the default messaging.

ParamTypeRequiredDefaultDescription
languageIdstringyesTwo letter ISO 639-1 Language Code

[Jamf Pro] Delete multiple configured languages from User-Initiated Enrollment settings. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this permanently deletes the enrollment messaging for every language id you pass, in a single call. List the configured languages with jamf_list_enrollment_languages first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Export enrollment history collection. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
exportFieldsstringnonullExport fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username
exportLabelsstringnonullExport labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username
fieldsJsonstringyesJSON object request body.
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name. This param can be combined with paging and sorting. Example: name=="script"
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,name:asc
ParamTypeRequiredDefaultDescription
idstringyesAutogenerated Access Group ID.
ParamTypeRequiredDefaultDescription
languageIdstringyesTwo letter ISO 639-1 Language Code

[Jamf Pro] Get Enrollment object and Re-enrollment settings. Returns the user-initiated enrollment configuration: what a user sees and agrees to when they enroll their own device. Change it with jamf_update_enrollment, which replaces the whole object.

[Jamf Pro] Retrieve the configured LDAP groups configured for User-Initiated Enrollment. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. Lists the LDAP groups that may complete user-initiated enrollment. This is the authorization boundary for who can add a device to the estate.

ParamTypeRequiredDefaultDescription
allUsersOptionFirstbooleannonullReturn "All LDAP Users" option on the first position if it is present in the current page
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: `property:asc/desc`. Default sort is `name:asc`. Multiple sort criteria are supported and must be separated with a comma. Example: `sort=date:desc,name:asc`.

[Jamf Pro] Get sorted and paged Enrollment history object. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: `property:asc/desc`. Default sort is `date:desc`. Multiple sort criteria are supported and must be separated with a comma. Example: `sort=date:desc,name:asc`.

[Jamf Pro] Get an array of the language codes that have Enrollment messaging. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. Lists the languages that have enrollment messaging configured. Use jamf_list_enrollment_language_codes for the full set of codes Jamf Pro accepts, and jamf_get_enrollment_languages to read the text for one of them.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is `languageCode:asc`. Multiple sort criteria are supported and must be separated with a comma. Example: `sort=date:desc,name:asc`.

[Jamf Pro] Update Enrollment object. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces the whole user-initiated enrollment configuration, so every field you omit is reset. These settings govern how users enroll their own devices. Read the current object with jamf_list_enrollment first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Modify the configured LDAP groups configured for User-Initiated Enrollment. Only exiting Access Groups can be updated. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces an existing enrollment access group entry, so every field you omit is reset, and it changes who may enroll devices. Read the entry with jamf_get_enrollment_access_groups first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesAutogenerated Access Group ID.

[Jamf Pro] Edit Enrollment messaging for a language. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces the enrollment messaging for one language, so every field you omit is reset. Read the current text with jamf_get_enrollment_languages first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
languageIdstringyesTwo letter ISO 639-1 Language Code

Enrollment Customization

ToolPlanAccessSummary
jamf_create_enrollment_customization_ldapProWriteCreate an LDAP Panel for a single Enrollment Customization.
jamf_create_enrollment_customization_parse_markdownFreeRead-onlyParse the given string as markdown text and return Html output.
jamf_create_enrollment_customization_ssoProWriteCreate an SSO Panel for a single Enrollment Customization.
jamf_create_enrollment_customization_textProWriteCreate a Text Panel for a single Enrollment Customization.
jamf_delete_enrollment_customization_allProDestructiveDelete a single Panel from an Enrollment Customization.
jamf_delete_enrollment_customization_ldapProDestructiveDelete an LDAP single panel from an Enrollment Customization.
jamf_delete_enrollment_customization_ssoProDestructiveDelete a single SSO Panel from an Enrollment Customization.
jamf_delete_enrollment_customization_textProDestructiveDelete a Text single Panel from an Enrollment Customization.
jamf_get_enrollment_customization_allFreeRead-onlyGet a single Panel for a single Enrollment Customization.
jamf_get_enrollment_customization_ldapFreeRead-onlyGet a single LDAP panel for a single Enrollment Customization.
jamf_get_enrollment_customization_ssoFreeRead-onlyGet a single SSO Panel for a single Enrollment Customization.
jamf_get_enrollment_customization_textFreeRead-onlyGet a single Text Panel for a single Enrollment Customization.
jamf_list_enrollment_customization_allFreeRead-onlyGet all Panels for single Enrollment Customization.
jamf_list_enrollment_customization_text_markdownFreeRead-onlyGet the markdown output of a single Text Panel for a single Enrollment.
jamf_update_enrollment_customization_ldapProDestructiveUpdate a single LDAP Panel for a single Enrollment Customization.
jamf_update_enrollment_customization_ssoProDestructiveUpdate a single SSO Panel for a single Enrollment Customization.
jamf_update_enrollment_customization_textProDestructiveUpdate a single Text Panel for a single Enrollment Customization.

[Jamf Pro] Create an LDAP Panel for a single Enrollment Customization. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesEnrollment Customization identifier

[Jamf Pro] Parse the given string as markdown text and return Html output. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. This renders markdown to HTML and changes nothing in Jamf Pro. Use it to preview the wording of a text panel before you save it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Create an SSO Panel for a single Enrollment Customization. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesEnrollment Customization identifier

[Jamf Pro] Create a Text Panel for a single Enrollment Customization. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesEnrollment Customization identifier

[Jamf Pro] Delete a single Panel from an Enrollment Customization. DESTRUCTIVE: this permanently deletes one panel from an enrollment customization. The panel disappears from the enrollment experience of every device that uses the customization.

ParamTypeRequiredDefaultDescription
idstringyesEnrollment Customization identifier
panelIdstringyesPanel object identifier

[Jamf Pro] Delete an LDAP single panel from an Enrollment Customization. DESTRUCTIVE: this permanently deletes one LDAP panel from an enrollment customization. The directory sign-in step it provided disappears from that enrollment experience.

ParamTypeRequiredDefaultDescription
idstringyesEnrollment Customization identifier
panelIdstringyesPanel object identifier

[Jamf Pro] Delete a single SSO Panel from an Enrollment Customization. DESTRUCTIVE: this permanently deletes one single sign-on panel from an enrollment customization. The sign-in step it provided disappears from that enrollment experience.

ParamTypeRequiredDefaultDescription
idstringyesEnrollment Customization identifier
panelIdstringyesPanel object identifier

[Jamf Pro] Delete a Text single Panel from an Enrollment Customization. DESTRUCTIVE: this permanently deletes one text panel from an enrollment customization. The wording it carried disappears from that enrollment experience.

ParamTypeRequiredDefaultDescription
idstringyesEnrollment Customization identifier
panelIdstringyesPanel object identifier
ParamTypeRequiredDefaultDescription
idstringyesEnrollment Customization identifier
panelIdstringyesPanel object identifier
ParamTypeRequiredDefaultDescription
idstringyesEnrollment Customization identifier
panelIdstringyesPanel object identifier
ParamTypeRequiredDefaultDescription
idstringyesEnrollment Customization identifier
panelIdstringyesPanel object identifier
ParamTypeRequiredDefaultDescription
idstringyesEnrollment Customization identifier
panelIdstringyesPanel object identifier

[Jamf Pro] Get all Panels for single Enrollment Customization. Lists every panel in one enrollment customization, in display order. The panel types are text, LDAP and single sign-on, each with its own get, create, update and delete tools.

ParamTypeRequiredDefaultDescription
idstringyesEnrollment Customization identifier
ParamTypeRequiredDefaultDescription
idstringyesEnrollment Customization identifier
panelIdstringyesPanel object identifier

[Jamf Pro] Update a single LDAP Panel for a single Enrollment Customization. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces one LDAP panel in an enrollment customization, so every field you omit is reset. The panel gates who may complete enrollment. Read it with jamf_get_enrollment_customization_ldap first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesEnrollment Customization identifier
panelIdstringyesPanel object identifier

[Jamf Pro] Update a single SSO Panel for a single Enrollment Customization. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces one single sign-on panel in an enrollment customization, so every field you omit is reset. The panel gates who may complete enrollment. Read it with jamf_get_enrollment_customization_sso first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesEnrollment Customization identifier
panelIdstringyesPanel object identifier

[Jamf Pro] Update a single Text Panel for a single Enrollment Customization. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces one text panel in an enrollment customization, so every field you omit is reset, and the wording is shown to users during enrollment. Read it with jamf_get_enrollment_customization_text first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesEnrollment Customization identifier
panelIdstringyesPanel object identifier

Enrollment Customizations

ToolPlanAccessSummary
jamf_create_enrollment_customizationsProWriteCreate an Enrollment Customization.
jamf_create_enrollment_customizations_historyProWriteAdd Enrollment Customization history object notes.
jamf_create_enrollment_customizations_imagesProDestructiveUpload an image.
jamf_delete_enrollment_customizationsProDestructiveDelete an Enrollment Customization with the supplied id.
jamf_get_enrollment_customizationsFreeRead-onlyRetrieve an Enrollment Customization with the supplied id.
jamf_list_enrollment_customizationsFreeRead-onlyRetrieve sorted and paged Enrollment Customizations.
jamf_list_enrollment_customizations_historyFreeRead-onlyGet sorted and paged Enrollment Customization history objects.
jamf_list_enrollment_customizations_prestagesFreeRead-onlyRetrieve the list of Prestages using this Enrollment Customization.
jamf_update_enrollment_customizationsProDestructiveUpdate an Enrollment Customization.

[Jamf Pro] Create an Enrollment Customization. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. Creating the customization gives you an empty shell. Add the panels users actually see with the text, LDAP and single sign-on panel create tools.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Add Enrollment Customization history object notes. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesEnrollment Customization identifier

[Jamf Pro] Upload an image. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this uploads an image into the enrollment customization image store. Uploaded images are shown to users during enrollment, so confirm the file before you send it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete an Enrollment Customization with the supplied id. DESTRUCTIVE: this permanently deletes an enrollment customization. Prestages that reference it lose their customized enrollment experience. Check which ones with jamf_list_enrollment_customizations_prestages first.

ParamTypeRequiredDefaultDescription
idstringyesEnrollment Customization identifier

[Jamf Pro] Retrieve an Enrollment Customization with the supplied id. Returns one enrollment customization. Read it before jamf_update_enrollment_customizations, which replaces the whole record.

ParamTypeRequiredDefaultDescription
idstringyesEnrollment Customization identifier

[Jamf Pro] Retrieve sorted and paged Enrollment Customizations. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. Lists the enrollment customizations, which brand and script the enrollment experience. Each one holds an ordered set of panels; read them with jamf_list_enrollment_customization_all.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Get sorted and paged Enrollment Customization history objects. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
idstringyesEnrollment Customization identifier
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property,asc/desc. Default sort order is descending. Multiple sort criteria are supported and must be entered on separate lines in Swagger UI. In the URI the 'sort' query param is duplicated for each sort criterion, e.g., ...&sort=name%2Casc&sort=date%2Cdesc

[Jamf Pro] Retrieve the list of Prestages using this Enrollment Customization. Lists the prestages that reference this enrollment customization. Check it before deleting the customization, because those prestages lose their customized experience.

ParamTypeRequiredDefaultDescription
idstringyesEnrollment Customization identifier

[Jamf Pro] Update an Enrollment Customization. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces an enrollment customization, so every field you omit is reset. Read the current object with jamf_get_enrollment_customizations first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesEnrollment Customization identifier

Inventory Preload

ToolPlanAccessSummary
jamf_create_inventory_preloadProDestructiveCreate a new Inventory Preload record using JSON or CSV.
jamf_create_inventory_preload_csvProDestructiveCreate one or more new Inventory Preload records using CSV.
jamf_create_inventory_preload_csv_validateFreeRead-onlyValidate a given CSV file.
jamf_create_inventory_preload_historyProWriteAdd Inventory Preload history object notes.
jamf_create_inventory_preload_history_notesProWriteAdd Inventory Preload history object notes.
jamf_create_inventory_preload_recordsProWriteCreate a new Inventory Preload record using JSON.
jamf_create_inventory_preload_records_delete_allProDestructiveDelete all Inventory Preload records.
jamf_create_inventory_preload_validate_csvFreeRead-onlyValidate a given CSV file.
jamf_delete_inventory_preloadProDestructiveDelete all Inventory Preload records.
jamf_delete_inventory_preload_idProDestructiveDelete an Inventory Preload record.
jamf_delete_inventory_preload_recordsProDestructiveDelete an Inventory Preload record.
jamf_export_inventory_preloadFreeRead-onlyExport a collection of inventory preload records.
jamf_get_inventory_preloadFreeRead-onlyGet an Inventory Preload record.
jamf_get_inventory_preload_recordsFreeRead-onlyGet an Inventory Preload record.
jamf_list_inventory_preloadFreeRead-onlyReturn all Inventory Preload records.
jamf_list_inventory_preload_csvFreeRead-onlyDownload all Inventory Preload records.
jamf_list_inventory_preload_csv_templateFreeRead-onlyDownload the Inventory Preload CSV template.
jamf_list_inventory_preload_ea_columnsFreeRead-onlyRetrieve a list of extension attribute columns.
jamf_list_inventory_preload_historyFreeRead-onlyGet Inventory Preload history entries.
jamf_list_inventory_preload_recordsFreeRead-onlyReturn all Inventory Preload records.
jamf_update_inventory_preloadProDestructiveUpdate an Inventory Preload record.
jamf_update_inventory_preload_recordsProDestructiveUpdate an Inventory Preload record.

[Jamf Pro] Create a new Inventory Preload record using JSON or CSV. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: Jamf overwrites any existing inventory preload record whose serial number matches your payload, and it creates or updates Jamf Pro user records for the usernames in the file. Validate the file first with jamf_create_inventory_preload_validate_csv. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Create one or more new Inventory Preload records using CSV. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: Jamf overwrites any existing inventory preload record whose serial number matches a row in the CSV, and it creates or updates Jamf Pro user records for the usernames in it. Validate the file first with jamf_create_inventory_preload_csv_validate.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Validate a given CSV file. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. This only validates the file and writes nothing. Run it before jamf_create_inventory_preload_csv, which overwrites matching records.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Add Inventory Preload history object notes. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Add Inventory Preload history object notes. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Create a new Inventory Preload record using JSON. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. This creates a single record from JSON and does not overwrite an existing one. Use jamf_create_inventory_preload_csv for bulk loads, but note that the CSV path overwrites matching serial numbers.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete all Inventory Preload records. DESTRUCTIVE: this deletes every inventory preload record in Jamf Pro. There is no undo and no filter. Export the current records with jamf_export_inventory_preload before you run it.

[Jamf Pro] Validate a given CSV file. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete all Inventory Preload records. DESTRUCTIVE: this deletes every inventory preload record in Jamf Pro. There is no undo and no filter. Export the current records with jamf_export_inventory_preload before you run it. To remove a single record, use jamf_delete_inventory_preload_records. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

[Jamf Pro] Delete an Inventory Preload record. DESTRUCTIVE: this permanently deletes one inventory preload record. The device it describes no longer receives preloaded inventory data when it enrolls. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
idstringyesInventory Preload identifier

[Jamf Pro] Delete an Inventory Preload record. DESTRUCTIVE: this permanently deletes one inventory preload record. The device it describes no longer receives preloaded inventory data when it enrolls.

ParamTypeRequiredDefaultDescription
idstringyesInventory Preload identifier

[Jamf Pro] Export a collection of inventory preload records. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. Exports the inventory preload collection. Run this before any of the delete-all tools, because those remove every record with no undo.

ParamTypeRequiredDefaultDescription
exportFieldsstringnonullExport fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username
exportLabelsstringnonullExport labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username
fieldsJsonstringyesJSON object request body.
filterstringnonullAllowing to filter inventory preload records. Default search is empty query - returning all results for the requested page. All inventory preload fields are supported, however fields added by extension attributes are not supported. If filtering by deviceType, use `0` for Computer and `1` for Mobile Device. Query in the RSQL format, allowing ``, `!=`, `>`, `<`, and `=in=`. Example: `filter=categoryName"Category"`
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: `property:asc/desc`. Default sort is `id:asc`. Multiple sort criteria are supported and must be separated with a comma. All inventory preload fields are supported, however fields added by extension attributes are not supported. If sorting by deviceType, use `0` for Computer and `1` for Mobile Device. Example: `sort=date:desc,name:asc`.

[Jamf Pro] Get an Inventory Preload record. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
idstringyesInventory Preload identifier

[Jamf Pro] Get an Inventory Preload record. Returns one inventory preload record. Read it before jamf_update_inventory_preload_records, which replaces the whole record.

ParamTypeRequiredDefaultDescription
idstringyesInventory Preload identifier

[Jamf Pro] Return all Inventory Preload records. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists. Lists inventory preload records: the data Jamf Pro applies to a device as soon as it enrolls. Records are matched on serial number, so a preload for a serial that never enrolls simply sits unused.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Get Inventory Preload history entries. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullAllows filtering inventory preload history records. Default search is empty query - returning all results for the requested page. All inventory preload history fields are supported. Query in the RSQL format, allowing ``, `!=`, `>`, `<`, and `=in=`. Example: `filter=username"admin"`
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: `property:asc/desc`. Default sort is `date:desc`. Multiple sort criteria are supported and must be separated with a comma. Example: `sort=date:desc,name:asc`.

[Jamf Pro] Return all Inventory Preload records. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Lists inventory preload records. Use jamf_list_inventory_preload_ea_columns to learn which extension attribute columns this server accepts, and jamf_list_inventory_preload_csv_template for the upload template.

ParamTypeRequiredDefaultDescription
filterstringnonullAllowing to filter inventory preload records. Default search is empty query - returning all results for the requested page. All inventory preload fields are supported, however fields added by extension attributes are not supported. If filtering by deviceType, use `0` for Computer and `1` for Mobile Device. Query in the RSQL format, allowing ``, `!=`, `>`, `<`, and `=in=`. Example: `filter=categoryName"Category"`
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: `property:asc/desc`. Default sort is `id:asc`. Multiple sort criteria are supported and must be separated with a comma. All inventory preload fields are supported, however fields added by extension attributes are not supported. If sorting by deviceType, use `0` for Computer and `1` for Mobile Device. Example: `sort=date:desc,name:asc`.

[Jamf Pro] Update an Inventory Preload record. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces one inventory preload record, so every field you omit is reset. Read the current record with jamf_get_inventory_preload first. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesInventory Preload identifier

[Jamf Pro] Update an Inventory Preload record. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces one inventory preload record, so every field you omit is reset. Read the current record with jamf_get_inventory_preload_records first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesInventory Preload identifier

Log Flush (Classic API)

ToolPlanAccessSummary
jamf_classic_delete_logflushProDestructiveFlushes a log specified in an XML file.
jamf_classic_delete_logflush_id_intervalProDestructiveFlushes a single log for a given interval.
jamf_classic_delete_logflush_intervalProDestructiveFlushes all logs for a given interval.

[Jamf Pro] Flushes a log specified in an XML file. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this permanently deletes the logs named in your XML document. Flushed logs cannot be recovered, and the policy and event history they carried is gone.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.

[Jamf Pro] Flushes a single log for a given interval. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this permanently deletes one log for the interval you name. Flushed logs cannot be recovered.

ParamTypeRequiredDefaultDescription
idstringyesID of policy whose log will be flushed
intervalstringyesSupported values are a combination of [Zero, One, Two, Three, Six] and [Days, Weeks, Months, Years]. For example, JSSResource/logflush/policies/id/1/interval/Three+Months
logstringyesAt this time, only 'policy' logs are supported

[Jamf Pro] Flushes all logs for a given interval. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this permanently deletes every log of the named type older than the interval you pass, across all devices. Flushed logs cannot be recovered.

ParamTypeRequiredDefaultDescription
intervalstringyesSupported values are a combination of [Zero, One, Two, Three, Six] and [Days, Weeks, Months, Years]. For example, JSSResource/logflush/policies/interval/Three+Months
logstringyesAt this time, only 'policy' logs are supported

Macos Managed Software Updates

ToolPlanAccessSummary
jamf_create_macos_managed_software_updates_send_updatesProDestructiveSend MacOs Managed Software Updates.
jamf_list_macos_managed_software_updates_available_updatesFreeRead-onlyRetrieve available MacOs Managed Software Updates.

[Jamf Pro] Send MacOs Managed Software Updates. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this sends macOS software update commands to the computers you name. Targeted Macs download and install the update and may restart. Confirm the target list and the maintenance window first. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Retrieve available MacOs Managed Software Updates. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

Managed Software Updates

ToolPlanAccessSummary
jamf_create_managed_software_updates_plansProDestructiveCreate a Managed Software Update Plan.
jamf_create_managed_software_updates_plans_groupProDestructiveCreate Managed Software Update Plans for a Group.
jamf_create_managed_sw_updates_plans_feature_toggle_abandonProDestructiveForce stops any ongoing or stalled feature-toggle processes.
jamf_get_managed_software_updates_plansFreeRead-onlyRetrieve a Managed Software Update Plan.
jamf_get_managed_software_updates_plans_groupFreeRead-onlyRetrieve Managed Software Update Plans for a Group.
jamf_get_managed_software_updates_update_statuses_computersFreeRead-onlyRetrieve Managed Software Update Statuses for Computers.
jamf_get_managed_software_updates_update_statuses_mobile_devicesFreeRead-onlyRetrieve Managed Software Update Statuses for Mobile Devices.
jamf_get_managed_sw_updates_update_statuses_computer_groupsFreeRead-onlyRetrieve Managed Software Update Statuses for Computer Groups.
jamf_get_managed_sw_updates_update_statuses_mobile_dev_groupsFreeRead-onlyRetrieve Managed Software Update Statuses for Mobile Device Groups.
jamf_list_managed_software_updates_available_updatesFreeRead-onlyRetrieve available macOS and iOS Managed Software Updates.
jamf_list_managed_software_updates_plansFreeRead-onlyRetrieve Managed Software Update Plans.
jamf_list_managed_software_updates_plans_declarationsFreeRead-onlyRetrieve all Declarations associated with a Managed Software Update Plan.
jamf_list_managed_software_updates_plans_eventsFreeRead-onlyRetrieve a Managed Software Update Plan Event Store.
jamf_list_managed_software_updates_plans_feature_toggleFreeRead-onlyRetrieve current value of the Feature Toggle.
jamf_list_managed_software_updates_plans_feature_toggle_statusFreeRead-onlyRetrieves background status of the Feature Toggle.
jamf_list_managed_software_updates_update_statusesFreeRead-onlyRetrieve Managed Software Update Statuses.
jamf_update_managed_software_updates_plans_feature_toggleProDestructiveUpdates Feature Toggle Value.

[Jamf Pro] Create a Managed Software Update Plan. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: creating a plan sends Download and Install OS Update commands to the computers and mobile devices in its scope. Targeted devices install the update and may restart. Confirm the scope and the deadline before you run it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Create Managed Software Update Plans for a Group. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: creating a group plan sends Download and Install OS Update commands to every member of the computer or mobile device group you name. Targeted devices install the update and may restart. Confirm the membership of that group first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Force stops any ongoing or stalled feature-toggle processes. DESTRUCTIVE: this force stops the managed software update feature toggle process, including work that is still in progress. Plans in flight are abandoned and their state is not recoverable.

[Jamf Pro] Retrieve a Managed Software Update Plan. Returns one managed software update plan, including its scope and deadline. Use jamf_list_managed_software_updates_plans_events for the timeline of what the plan has done.

ParamTypeRequiredDefaultDescription
idstringyesManaged Software Update Plan Uuid
ParamTypeRequiredDefaultDescription
groupTypestringyesManaged Software Update Group Type, Available options are "COMPUTER_GROUP" or "MOBILE_DEVICE_GROUP"
idstringyesManaged Software Update Group Id
ParamTypeRequiredDefaultDescription
idstringyesComputer identifier
ParamTypeRequiredDefaultDescription
idstringyesMobile Device identifier
ParamTypeRequiredDefaultDescription
idstringyesComputer Group identifier
ParamTypeRequiredDefaultDescription
idstringyesMobile Device Group identifier

[Jamf Pro] Retrieve available macOS and iOS Managed Software Updates. Lists the OS versions this server can currently deploy. Read it before you build a plan, so the version you target is one Jamf can actually send.

[Jamf Pro] Retrieve Managed Software Update Plans. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Lists managed software update plans. A plan is not a draft: creating one sends install commands to the devices in its scope. Follow what those devices did with jamf_list_managed_software_updates_update_statuses.

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter Managed Software Updates collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: planUuid, device.deviceId, device.objectType, updateAction, versionType, specificVersion, maxDeferrals, recipeId, forceInstallLocalDateTime, state.
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is planUuid:asc. Multiple sort criteria are supported and must be separated with a comma.
ParamTypeRequiredDefaultDescription
idstringyesManaged Software Update Plan Uuid
ParamTypeRequiredDefaultDescription
idstringyesManaged Software Update Plan Uuid

[Jamf Pro] Retrieve Managed Software Update Statuses. filter takes an RSQL expression, for example general.name=="MacBook*". Reports per-device progress for managed software updates. Use the computer-specific and mobile-device-specific status tools when you already know which device you are chasing.

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter Managed Software Updates collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: osUpdatesStatusId, device.deviceId, device.objectType, downloaded, downloadPercentComplete, productKey, status, deferralsRemaining, maxDeferrals, nextScheduledInstall, created and updated.

[Jamf Pro] Updates Feature Toggle Value. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this switches the managed software update feature toggle for the whole Jamf Pro server, changing which update mechanism every plan uses. Read the current value with jamf_list_managed_software_updates_plans_feature_toggle first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

MDM Commands

ToolPlanAccessSummary
jamf_blank_push_mdmProDestructiveSend blank push notifications to a list of client management IDs.
jamf_create_mdm_commandsProDestructivePost a command for creation and queuing.
jamf_create_mdm_renew_profileProDestructiveRenew MDM Profile.
jamf_list_mdm_commandsFreeRead-onlyGet information about mdm commands made by Jamf Pro.

[Jamf Pro] Send blank push notifications to a list of client management IDs. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this sends a blank push notification to every client management id you list, waking those devices and making them check in with Jamf Pro immediately.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Post a command for creation and queuing. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this queues an MDM command against the devices you name, and the command body decides what happens. It can erase a device, lock it, remove its management profile or reset a passcode. Confirm both the command type and the full target list before you run it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Renew MDM Profile. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this renews the MDM enrollment profile on the devices you name. A renewal that fails can leave a device unmanaged until it enrolls again.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Get information about mdm commands made by Jamf Pro. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Lists queued and completed MDM commands. Use it to confirm whether a command is still pending before you flush it with jamf_classic_delete_commandflush_id_status.

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter, for a list of commands. All url must contain minimum one filter field. Fields allowed in the query: uuid, clientManagementId, command, status, clientType, dateSent, validAfter, dateCompleted, profileId, profileIdentifier, and active. This param can be combined with paging. Please note that any date filters must be used with gt, lt, ge, le Example: clientManagementIdfb511aae-c557-474f-a9c1-5dc845b90d0f;statusPending;commandINSTALL_PROFILE;uuid9e18f849-e689-4f2d-b616-a99d3da7db42;clientTypeCOMPUTER_USER;profileId1;profileIdentifier18cc61c2-01fc-11ed-b939-0242ac120002;dateCompleted=ge=2021-08-04T14:25:18.26Z;dateCompleted=le=2021-08-04T14:25:18.26Z;validAfter=ge=2021-08-05T14:25:18.26Z;activetrue
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullDefault sort is dateSent:asc. Multiple sort criteria are supported and must be separated with a comma.

MDM Profile Renewal

ToolPlanAccessSummary
jamf_delete_mdm_renewal_renewal_strategiesProDestructiveDelete MDM renewal strategies for a client management ID.
jamf_get_mdm_renewal_device_common_detailsFreeRead-onlyGet device common details for a client management ID.
jamf_get_mdm_renewal_renewal_strategiesFreeRead-onlyGet MDM renewal errors and strategies for a client management ID.
jamf_patch_mdm_renewal_device_common_detailsProWriteUpdate device common details (partial update).

[Jamf Pro] Delete MDM renewal strategies for a client management ID. DESTRUCTIVE: this permanently deletes the MDM renewal strategies for one client management id. That device falls back to the server default at its next renewal.

ParamTypeRequiredDefaultDescription
clientManagementIdstringyesThe client management ID to delete renewal strategies for

[Jamf Pro] Get device common details for a client management ID. Returns the device common details used when the MDM profile is renewed. Update it with jamf_patch_mdm_renewal_device_common_details, which is a documented partial update and only touches the fields you send.

ParamTypeRequiredDefaultDescription
clientManagementIdstringyesThe client management ID to retrieve device common details for
ParamTypeRequiredDefaultDescription
clientManagementIdstringyesThe client management ID to retrieve renewal strategies for

[Jamf Pro] Update device common details (partial update). Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. This is a partial update: fields you leave out keep their current values, and it never creates a record. The clientManagementId in the body selects which record is updated.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Onboarding

ToolPlanAccessSummary
jamf_create_onboarding_historyProWriteAdd Onboarding history object notes.
jamf_export_onboarding_historyFreeRead-onlyExport history object collection in specified format for Onboarding.
jamf_list_onboardingFreeRead-onlyGet the current onboarding settings configuration.
jamf_list_onboarding_eligible_appsFreeRead-onlyRetrieves a list of applications that are eligible to be used in an onboarding configuration.
jamf_list_onboarding_eligible_configuration_profilesFreeRead-onlyRetrieves a list of configuration profiles that are eligible to be used in an onboarding configuration.
jamf_list_onboarding_eligible_policiesFreeRead-onlyRetrieves a list of policies that are eligible to be used in an onboarding configuration.
jamf_list_onboarding_historyFreeRead-onlyGet Onboarding history object.
jamf_update_onboardingProDestructiveUpdate the onboarding configuration.

[Jamf Pro] Add Onboarding history object notes. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Export history object collection in specified format for Onboarding. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
exportFieldsstringnonullExport fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username
exportLabelsstringnonullExport labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username
fieldsJsonstringyesJSON object request body.
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and date<2019-12-15
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Get the current onboarding settings configuration. Returns the onboarding configuration, which decides what a user sees the first time a new device is set up. The eligible-apps, eligible-policies and eligible-configuration-profiles tools list what you may reference in it.

[Jamf Pro] Retrieves a list of applications that are eligible to be used in an onboarding configuration. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Retrieves a list of configuration profiles that are eligible to be used in an onboarding configuration. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Retrieves a list of policies that are eligible to be used in an onboarding configuration. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Get Onboarding history object. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and date<2019-12-15
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Update the onboarding configuration. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces the whole onboarding configuration, so every field you omit is reset. Onboarding decides what a user sees the first time a new device is set up. Read the current object with jamf_list_onboarding first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Patch Available Titles (Classic API)

ToolPlanAccessSummary
jamf_classic_get_patchavailabletitles_sourceidFreeRead-onlyFinds all available title from a source by ID.

[Jamf Pro] Finds all available title from a source by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID of the internal or external patch source to filter by

Patch External Sources (Classic API)

ToolPlanAccessSummary
jamf_classic_create_patchexternalsources_idProWriteCreate a new patch external source by ID.
jamf_classic_create_patchexternalsources_nameProWriteCreate a new patch external source by name.
jamf_classic_delete_patchexternalsources_idProDestructiveDeletes a patch external source by ID.
jamf_classic_get_patchexternalsources_idFreeRead-onlyFinds a patch external source by ID.
jamf_classic_get_patchexternalsources_nameFreeRead-onlyFinds the first patch external source with the name provided.
jamf_classic_list_patchexternalsourcesFreeRead-onlyFinds all patch external sources.
jamf_classic_update_patchexternalsources_idProDestructiveUpdates a patch external source by ID.
jamf_classic_update_patchexternalsources_nameProDestructiveUpdates a patch external source by name.

[Jamf Pro] Create a new patch external source by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Create a new patch external source by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName to filter by

[Jamf Pro] Deletes a patch external source by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this permanently deletes a patch external source. Patch software titles that draw their definitions from it stop receiving updates.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds a patch external source by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds the first patch external source with the name provided. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all patch external sources. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Updates a patch external source by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: the Classic API replaces the whole patch external source from your XML document, so anything the document omits is cleared. Read the current record with jamf_classic_get_patchexternalsources_id first.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Updates a patch external source by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: the Classic API replaces the whole patch external source from your XML document, so anything the document omits is cleared. Read the current record with jamf_classic_get_patchexternalsources_name first.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName to filter by

Patch Internal Sources (Classic API)

ToolPlanAccessSummary
jamf_classic_get_patchinternalsources_idFreeRead-onlyFinds a patch internal source by ID.
jamf_classic_get_patchinternalsources_nameFreeRead-onlyFinds the first patch internal source with the name provided.
jamf_classic_list_patchinternalsourcesFreeRead-onlyFinds all patch internal sources.

[Jamf Pro] Finds a patch internal source by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds the first patch internal source with the name provided. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Finds all patch internal sources. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

Patch Management (Classic API)

ToolPlanAccessSummary
jamf_classic_create_patches_idProWriteCreates a patch software title (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".).
jamf_classic_delete_patches_idProDestructiveDeletes a Patch Software Title by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/".).
jamf_classic_delete_patches_nameProDestructiveDeletes a Patch Software Title by name (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".).
jamf_classic_get_patches_idFreeRead-onlyFinds patches by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/".).
jamf_classic_get_patches_id_versionFreeRead-onlyDisplay computers on a specific version (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations//definitions".).
jamf_classic_get_patches_nameFreeRead-onlyFinds the first patch with the name provided (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/".).
jamf_classic_get_patches_name_versionFreeRead-onlyDisplay computers on a specific version (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".).
jamf_classic_list_patchesFreeRead-onlyFinds all patches (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".
jamf_classic_update_patches_idProDestructiveUpdates a Patch Software Title by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/".).
jamf_classic_update_patches_nameProDestructiveUpdates a Patch Software Title by name (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".).

[Jamf Pro] Creates a patch software title (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".). Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesPath parameter 'id'.

[Jamf Pro] Deletes a Patch Software Title by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/".). Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this permanently deletes a patch software title along with the patch policies that hang off it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a Patch Software Title by name (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".). Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this permanently deletes a patch software title along with the patch policies that hang off it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Finds patches by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/".). Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Display computers on a specific version (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations//definitions".). Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
idstringyesID to filter by
versionstringyesVersion number to filter by

[Jamf Pro] Finds the first patch with the name provided (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/".). Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Display computers on a specific version (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".). Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by
versionstringyesVersion number to filter by

[Jamf Pro] Finds all patches (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations". Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

[Jamf Pro] Updates a Patch Software Title by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/".). Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: the Classic API replaces the whole patch software title from your XML document, so anything the document omits is cleared. Read the current record with jamf_classic_get_patches_id first. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to update by

[Jamf Pro] Updates a Patch Software Title by name (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".). Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: the Classic API replaces the whole patch software title from your XML document, so anything the document omits is cleared. Read the current record with jamf_classic_get_patches_name first. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to update by

Patch Management Accept Disclaimer

ToolPlanAccessSummary
jamf_create_patch_management_accept_disclaimerProDestructiveAccept Patch Management disclaimer.

[Jamf Pro] Accept Patch Management disclaimer. DESTRUCTIVE: this accepts the Jamf patch management disclaimer on behalf of the organization. It records a legal acknowledgement against the Jamf Pro server and cannot be withdrawn through the API.

Patch Policies

ToolPlanAccessSummary
jamf_create_patch_policies_dashboardProWriteAdd a patch policy to the dashboard.
jamf_create_patch_policies_logs_retry_allProDestructiveSend retry attempts for all devices.
jamf_delete_patch_policies_dashboardProDestructiveRemove a patch policy from the dashboard.
jamf_get_patch_policies_logsFreeRead-onlyRetrieves a single Patch Policy Log.
jamf_list_patch_policiesFreeRead-onlyRetrieve Patch Policies.
jamf_list_patch_policies_dashboardFreeRead-onlyReturn whether or not the requested patch policy is on the dashboard.
jamf_list_patch_policies_logsFreeRead-onlyRetrieve Patch Policy Logs.
jamf_list_patch_policies_logs_detailsFreeRead-onlyReturn attempt details for a specific log.
jamf_list_patch_policies_logs_eligible_retry_countFreeRead-onlyReturn the count of the Patch Policy Logs for the patch policy id that are eligible for a retry attempt.
jamf_list_patch_policies_policy_detailsFreeRead-onlyRetrieve Patch Policies.
jamf_retry_patch_policies_logsProDestructiveSend retry attempts for specific devices.
ParamTypeRequiredDefaultDescription
idstringyespatch policy id

[Jamf Pro] Send retry attempts for all devices. DESTRUCTIVE: this retries the patch policy on every eligible device at once, so each of them installs the patched software. Check how many devices that is with jamf_list_patch_policies_logs_eligible_retry_count first.

ParamTypeRequiredDefaultDescription
idstringyespatch policy id

[Jamf Pro] Remove a patch policy from the dashboard. DESTRUCTIVE: this removes the patch policy from the Jamf Pro dashboard. The policy itself keeps running; only its dashboard tile goes away. Add it back with jamf_create_patch_policies_dashboard.

ParamTypeRequiredDefaultDescription
idstringyespatch policy id
ParamTypeRequiredDefaultDescription
deviceIdstringyesdevice id
idstringyespatch policy id

[Jamf Pro] Retrieve Patch Policies. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Lists patch policies, which install patched software on the computers in their scope. Use jamf_list_patch_policies_logs for per-device results and jamf_list_patch_policies_policy_details for the scope and settings.

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter Patch Policy collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, policyName, policyEnabled, policyTargetVersion, policyDeploymentMethod, softwareTitle, softwareTitleConfigurationId, pending, completed, deferred, and failed. This param can be combined with paging and sorting.
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma.
ParamTypeRequiredDefaultDescription
idstringyespatch policy id

[Jamf Pro] Retrieve Patch Policy Logs. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Reports per-device results for one patch policy. Use jamf_list_patch_policies_logs_eligible_retry_count to size a retry before you run jamf_create_patch_policies_logs_retry_all.

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter Patch Policy Logs collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: deviceId, deviceName, statusCode, statusDate, attemptNumber, ignoredForPatchPolicyId. This param can be combined with paging and sorting.
idstringyespatch policy id
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is deviceName:asc. Multiple sort criteria are supported and must be separated with a comma.
ParamTypeRequiredDefaultDescription
deviceIdstringyesdevice id
idstringyespatch policy id
ParamTypeRequiredDefaultDescription
idstringyespatch policy id

[Jamf Pro] Retrieve Patch Policies. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter Patch Policy collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name, enabled, targetPatchVersion, deploymentMethod, softwareTitleId, softwareTitleConfigurationId, killAppsDelayMinutes, killAppsMessage, isDowngrade, isPatchUnknownVersion, notificationHeader, selfServiceEnforceDeadline, selfServiceDeadline, installButtonText, selfServiceDescription, iconId, reminderFrequency, reminderEnabled. This param can be combined with paging and sorting.
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma.

[Jamf Pro] Send retry attempts for specific devices. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this retries the patch policy on the devices you name, so each of them installs the patched software. Confirm the device list before you run it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyespatch policy id

Patch Policies (Classic API)

ToolPlanAccessSummary
jamf_classic_create_patchpolicies_softwaretitleconfig_idProDestructiveCreate a new patch policy associated with a patch software title configuration ID.
jamf_classic_delete_patchpolicies_idProDestructiveDeletes a patch policy by ID.
jamf_classic_get_patchpolicies_idFreeRead-onlyFinds a patch policy by ID.
jamf_classic_get_patchpolicies_id_subsetFreeRead-onlyDisplay subsets of information for a patch policy.
jamf_classic_get_patchpolicies_softwaretitleconfig_idFreeRead-onlyFinds all patch policies by patch software title configuration ID (Deprecated).
jamf_classic_list_patchpoliciesFreeRead-onlyFinds all patch policies.
jamf_classic_update_patchpolicies_idProDestructiveUpdates an existing patch policy by ID.

[Jamf Pro] Create a new patch policy associated with a patch software title configuration ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: a patch policy installs software on the computers in its scope. Your XML document carries both the scope and the enablement flag, so this call can start a deployment across the estate as soon as the scoped Macs check in. Confirm the scope before you run it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
softwaretitleconfigidstringyesPatch software title config ID value to filter by

[Jamf Pro] Deletes a patch policy by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this permanently deletes a patch policy. The computers in its scope stop receiving the patched software.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds a patch policy by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Display subsets of information for a patch policy. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID to filter by
subsetstringyesSubset to filter by

[Jamf Pro] Finds all patch policies by patch software title configuration ID (Deprecated). Please transition use to Jamf Pro API endpoint "/v2/patch-policies". Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
softwaretitleconfigidstringyesPatch software title config ID value to filter by

[Jamf Pro] Finds all patch policies. (Deprecated). Please transition use to Jamf Pro API endpoint "/v2/patch-policies". Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

[Jamf Pro] Updates an existing patch policy by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: the Classic API replaces the whole patch policy from your XML document, so anything the document omits is cleared. Because the document carries the scope and the enablement flag, an edit can start or stop a deployment. Read the current policy with jamf_classic_get_patchpolicies_id first.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

Patch Reports (Classic API)

ToolPlanAccessSummary
jamf_classic_get_patchreports_patchsoftwaretitleidFreeRead-onlyFinds patch reports by patch software title ID.
jamf_classic_get_patchreports_patchsoftwaretitleid_versionFreeRead-onlyDisplay computers for a specific version of a patch report.

[Jamf Pro] Finds patch reports by patch software title ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations//patch-report". Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
idstringyesPatch software title id to filter by

[Jamf Pro] Display computers for a specific version of a patch report. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations//patch-report". Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
idstringyesPatch software title ID to filter by
versionstringyesVersion number to filter by

Patch Software Title Configurations

ToolPlanAccessSummary
jamf_create_patch_software_title_configurationsProWriteCreate Patch Software Title Configurations.
jamf_create_patch_software_title_configurations_dashboardProWriteAdd a software title configuration to the dashboard.
jamf_create_patch_software_title_configurations_historyProWriteAdd Patch Software Title Configuration history object notes.
jamf_delete_patch_software_title_configurationsProDestructiveDelete Patch Software Title Configurations with the supplied id.
jamf_delete_patch_software_title_configurations_dashboardProDestructiveRemove a software title configuration from the dashboard.
jamf_get_patch_software_title_configurationsFreeRead-onlyRetrieve Patch Software Title Configurations with the supplied id.
jamf_list_patch_software_title_configs_extension_attributesFreeRead-onlyRetrieve Software Title Extension Attributes with the supplied id.
jamf_list_patch_software_title_configs_patch_summary_versionsFreeRead-onlyReturns patch versions.
jamf_list_patch_software_title_configurationsFreeRead-onlyRetrieve Patch Software Title Configurations.
jamf_list_patch_software_title_configurations_dashboardFreeRead-onlyReturn whether or not the requested software title configuration is on the dashboard.
jamf_list_patch_software_title_configurations_definitionsFreeRead-onlyRetrieve Patch Software Title Definitions with the supplied id.
jamf_list_patch_software_title_configurations_dependenciesFreeRead-onlyRetrieve list of Patch Software Title Configuration Dependencies.
jamf_list_patch_software_title_configurations_export_reportFreeRead-onlyExport Patch Reporting Data.
jamf_list_patch_software_title_configurations_historyFreeRead-onlyGet specified Patch Software Title Configuration history object.
jamf_list_patch_software_title_configurations_patch_reportFreeRead-onlyRetrieve Patch Software Title Configuration Patch Report.
jamf_list_patch_software_title_configurations_patch_summaryFreeRead-onlyReturn Active Patch Summary.
jamf_patch_patch_software_title_configurationsProWriteUpdate Patch Software Title Configurations.

[Jamf Pro] Create Patch Software Title Configurations. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
ParamTypeRequiredDefaultDescription
idstringyessoftware title configuration id

[Jamf Pro] Add Patch Software Title Configuration history object notes. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesPatch Software Title Configuration Id

[Jamf Pro] Delete Patch Software Title Configurations with the supplied id. DESTRUCTIVE: this permanently deletes a patch software title configuration. Patch policies that depend on it stop working. Check what depends on it with jamf_list_patch_software_title_configurations_dependencies first.

ParamTypeRequiredDefaultDescription
idstringyesPatch Software Title Configurations identifier

[Jamf Pro] Remove a software title configuration from the dashboard. DESTRUCTIVE: this removes the software title configuration from the Jamf Pro dashboard. The configuration itself is untouched; only its dashboard tile goes away.

ParamTypeRequiredDefaultDescription
idstringyessoftware title configuration id

[Jamf Pro] Retrieve Patch Software Title Configurations with the supplied id. Returns one patch software title configuration. Update it with jamf_patch_patch_software_title_configurations, which is a documented partial merge and only changes the fields you send.

ParamTypeRequiredDefaultDescription
idstringyesPatch Software Title Configurations identifier
ParamTypeRequiredDefaultDescription
idstringyesPatch Software Title identifier
ParamTypeRequiredDefaultDescription
idstringyesPatch id

[Jamf Pro] Retrieve Patch Software Title Configurations. Lists patch software title configurations: the definitions Jamf Pro tracks for third-party software. Patch policies reference these, so check jamf_list_patch_software_title_configurations_dependencies before deleting one.

ParamTypeRequiredDefaultDescription
idstringyessoftware title configuration id

[Jamf Pro] Retrieve Patch Software Title Definitions with the supplied id. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter Patch Software Title Definition collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, version, minimumOperatingSystem, releaseDate, reboot, standalone and absoluteOrderId. This param can be combined with paging and sorting.
idstringyesPatch Software Title identifier
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is absoluteOrderId:asc. Multiple sort criteria are supported and must be separated with a comma.
ParamTypeRequiredDefaultDescription
idstringyesPatch Software Title Configuration Id

[Jamf Pro] Export Patch Reporting Data. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
columnsToExportstringyesList of column names to export
filterstringnonullQuery in the RSQL format, allowing to filter Patch Report collection on version equality only. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: version. Comparators allowed in the query: ==, != This param can be combined with paging and sorting.
idstringyesPatch Software Title Configurations identifier

[Jamf Pro] Get specified Patch Software Title Configuration history object. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15
idstringyesPatch Software Title Configuration Id
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma.

[Jamf Pro] Retrieve Patch Software Title Configuration Patch Report. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter Patch Report collection on version equality only. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: version. Comparators allowed in the query: ==, != This param can be combined with paging and sorting.
idstringyesPatch Software Title Configurations identifier
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is computerName:asc. Multiple sort criteria are supported and must be separated with a comma. Supported fields: computerName, deviceId, username, operatingSystemVersion, lastCheckIn, buildingName, departmentName, siteName, version

[Jamf Pro] Return Active Patch Summary. Summarizes how much of the estate is on the patched version of this software title. Use the patch report tool for the per-device breakdown.

ParamTypeRequiredDefaultDescription
idstringyesPatch id

[Jamf Pro] Update Patch Software Title Configurations. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. This is a documented merge patch, so fields you leave out keep their current values. Read the current object with jamf_get_patch_software_title_configurations first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesPatch Software Title Configurations identifier

Patch Software Titles (Classic API)

ToolPlanAccessSummary
jamf_classic_create_patchsoftwaretitles_idProWriteCreates new patch software title by ID.
jamf_classic_delete_patchsoftwaretitles_idProDestructiveDeletes a patch software title by ID.
jamf_classic_get_patchsoftwaretitles_idFreeRead-onlyFinds a patch software titles by ID.
jamf_classic_list_patchsoftwaretitlesFreeRead-onlyFinds all patch software titles.
jamf_classic_update_patchsoftwaretitles_idProDestructiveUpdates a patch software title by ID.

[Jamf Pro] Creates new patch software title by ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/". Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a patch software title by ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/". Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this permanently deletes a patch software title along with the patch policies that depend on it. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
idstringyesID value to update by

[Jamf Pro] Finds a patch software titles by ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/". Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Finds all patch software titles. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations". Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

[Jamf Pro] Updates a patch software title by ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/". Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: the Classic API replaces the whole patch software title from your XML document, so anything the document omits is cleared. Read the current record with jamf_classic_get_patchsoftwaretitles_id first. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to update by

Reenrollment

ToolPlanAccessSummary
jamf_create_reenrollment_historyProWriteAdd specified Re-enrollment history object notes.
jamf_export_reenrollment_historyFreeRead-onlyExport reenrollment history collection.
jamf_list_reenrollmentFreeRead-onlyGet Re-enrollment object.
jamf_list_reenrollment_historyFreeRead-onlyGet Re-enrollment history object.
jamf_update_reenrollmentProDestructiveUpdate the Re-enrollment object.

[Jamf Pro] Add specified Re-enrollment history object notes. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Export reenrollment history collection. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
exportFieldsstringnonullExport fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username
exportLabelsstringnonullExport labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username
fieldsJsonstringyesJSON object request body.
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name. This param can be combined with paging and sorting. Example: name=="script"
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,name:asc

[Jamf Pro] Get Re-enrollment object. Returns the re-enrollment configuration, which decides what Jamf Pro keeps when a device enrolls again. Change it with jamf_update_reenrollment, which replaces the whole object.

[Jamf Pro] Get Re-enrollment history object. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Update the Re-enrollment object. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces the whole re-enrollment configuration, so every field you omit is reset. The configuration decides what Jamf Pro keeps when a device enrolls again, so a wrong value can discard device history. Read the current object with jamf_list_reenrollment first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Return To Service

ToolPlanAccessSummary
jamf_create_return_to_serviceProWriteCreate a Return to Service Configuration.
jamf_delete_return_to_serviceProDestructiveDelete a Return To Service Configuration with the supplied id.
jamf_get_return_to_serviceFreeRead-onlyRetrieve a Return to Service Configuration with the supplied id.
jamf_list_return_to_serviceFreeRead-onlyGet all Return to Service Configurations.
jamf_update_return_to_serviceProDestructiveUpdate a Return to Service Configuration.

[Jamf Pro] Create a Return to Service Configuration. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. Creating a configuration does not apply it to any device on its own; a device uses it when it is wiped with return to service enabled.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete a Return To Service Configuration with the supplied id. DESTRUCTIVE: this permanently deletes a return to service configuration. Wiped devices that referenced it no longer enroll again automatically.

ParamTypeRequiredDefaultDescription
idstringyesReturn To Service Configurations identifier
ParamTypeRequiredDefaultDescription
idstringyesReturn to Service Configuration identifier

[Jamf Pro] Get all Return to Service Configurations. Lists return to service configurations, which let a wiped device enroll again without a person touching it. Read one with jamf_get_return_to_service before you update it.

[Jamf Pro] Update a Return to Service Configuration. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces a return to service configuration, so every field you omit is reset. Read the current object with jamf_get_return_to_service first.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesReturn to Service Configuration identifier

Service Discovery Enrollment

ToolPlanAccessSummary
jamf_list_service_discovery_enrollment_well_known_settingsFreeRead-onlyGet service discovery well-known settings for all organizations.
jamf_update_service_discovery_enrollment_well_known_settingsProDestructiveUpdate service discovery well-known settings.

[Jamf Pro] Update service discovery well-known settings. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this replaces the service discovery well-known settings that Apple devices read to find this Jamf Pro server. A wrong value stops new devices from discovering the enrollment endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Account Groups

ToolPlanAccessSummary
jamf_get_account_groupsFreeRead-onlyGet one Jamf Pro account group by ID, including its privilege set and the accounts that belong to it.
jamf_list_account_groupsFreeRead-onlyList the Jamf Pro account groups, the groups that carry privilege sets for Jamf Pro administrators.

[Jamf Pro] Get one Jamf Pro account group by ID, including its privilege set and the accounts that belong to it. Find the ID with jamf_list_account_groups.

ParamTypeRequiredDefaultDescription
idstringyesid of target account group

[Jamf Pro] List the Jamf Pro account groups, the groups that carry privilege sets for Jamf Pro administrators. Use jamf_get_account_groups for one group full privilege list. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format to filter account groups collection. An empty query returns all results for the requested page. Supported fields: id, name, siteId, ldapServerId. Multiple conditions can be combined using logical operators. This parameter can be used with paging and sorting parameters. Example: name=="Admins" and siteId==-1
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is name:asc. Multiple sort criteria are supported and must be separated with a comma. Accepts fields: id, name, siteId, ldapServerId.

Account Preferences

ToolPlanAccessSummary
jamf_list_account_preferencesFreeRead-onlyGet the Jamf Pro interface preferences of the account whose API credentials this connection uses, such as language, date format and results per page.
jamf_patch_account_preferencesProWriteUpdate the Jamf Pro interface preferences of the account whose API credentials this connection uses.

[Jamf Pro] Update the Jamf Pro interface preferences of the account whose API credentials this connection uses. Only the fields you send change, and this affects the API account rather than any managed device. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Accounts

ToolPlanAccessSummary
jamf_create_accountsProDestructiveCreate a Jamf Pro user account.
jamf_delete_accountsProDestructiveDelete a Jamf Pro user account by ID.
jamf_get_accountsFreeRead-onlyGet one Jamf Pro user account by ID.
jamf_list_accountsFreeRead-onlyList the Jamf Pro user accounts through the current Jamf Pro API.
jamf_update_accountsProDestructiveUpdate a Jamf Pro user account by ID.

[Jamf Pro] Create a Jamf Pro user account. This grants a new person administrative access to Jamf Pro at the privilege level you send. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete a Jamf Pro user account by ID. The person loses all Jamf Pro access at once and the account cannot be recovered. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesid of target account

[Jamf Pro] Get one Jamf Pro user account by ID. Find the ID with jamf_list_accounts.

ParamTypeRequiredDefaultDescription
idstringyesid of target account

[Jamf Pro] List the Jamf Pro user accounts through the current Jamf Pro API. Use jamf_get_accounts for one account full record. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format to filter user accounts collection. An empty query returns all results for the requested page. Supported fields: id, lastPasswordChange, failedLoginAttempts, username, realname, email, phone, ldapServerId, distinguishedName, siteId, privilegeLevel, changePasswordOnNextLogin, accountStatus. Multiple conditions can be combined using logical operators. This parameter can be used with paging and sorting parameters. Example: username=="admin" and accountStatusEnabled and failedLoginAttempts0
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is username:desc. Multiple sort criteria are supported and must be separated with a comma. Accepts fields: id, lastPasswordChange, failedLoginAttempts, username, realname, email, phone, ldapServerId, distinguishedName, siteId, privilegeLevel, changePasswordOnNextLogin, accountStatus. If any other field is passed it will be ignored in sorting operation and/or create unpredictable results.

[Jamf Pro] Update a Jamf Pro user account by ID. This can change the account privileges, access level and site, so it can widen or remove a person administrative access. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesid of target account

Accounts (Classic API)

ToolPlanAccessSummary
jamf_classic_create_accounts_groupidProDestructiveCreate a Jamf Pro account group at the given ID.
jamf_classic_create_accounts_useridProDestructiveCreate a Jamf Pro administrator account at the given ID.
jamf_classic_delete_accounts_groupidProDestructiveDelete a Jamf Pro account group by ID.
jamf_classic_delete_accounts_groupnameProDestructiveDelete a Jamf Pro account group by name.
jamf_classic_delete_accounts_useridProDestructiveDelete a Jamf Pro administrator account by ID.
jamf_classic_delete_accounts_usernameProDestructiveDelete a Jamf Pro administrator account by user name.
jamf_classic_get_accounts_groupidFreeRead-onlyGet one Jamf Pro account group by ID, including its privilege set and members.
jamf_classic_get_accounts_groupnameFreeRead-onlyGet one Jamf Pro account group by name, including its privilege set and members.
jamf_classic_get_accounts_useridFreeRead-onlyGet one Jamf Pro administrator account by ID, including its access level, privilege set and site assignment.
jamf_classic_get_accounts_usernameFreeRead-onlyGet one Jamf Pro administrator account by user name, including its access level, privilege set and site assignment.
jamf_classic_list_accountsFreeRead-onlyList every Jamf Pro administrator account and account group.
jamf_classic_update_accounts_groupidProDestructiveReplace a Jamf Pro account group by ID.
jamf_classic_update_accounts_groupnameProDestructiveReplace a Jamf Pro account group by name.
jamf_classic_update_accounts_useridProDestructiveReplace a Jamf Pro administrator account by ID.
jamf_classic_update_accounts_usernameProDestructiveReplace a Jamf Pro administrator account by user name.

[Jamf Pro] Create a Jamf Pro account group at the given ID. Every member of the group inherits the privilege set in the XML document. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Create a Jamf Pro administrator account at the given ID. This grants a new person administrative access at the privilege level in the XML document. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Delete a Jamf Pro account group by ID. Every member loses the privileges the group granted. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Delete a Jamf Pro account group by name. Every member loses the privileges the group granted. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Delete a Jamf Pro administrator account by ID. The person loses all Jamf Pro access at once and the account cannot be recovered. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Delete a Jamf Pro administrator account by user name. The person loses all Jamf Pro access at once and the account cannot be recovered. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Get one Jamf Pro account group by ID, including its privilege set and members. Find the ID with jamf_classic_list_accounts. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Get one Jamf Pro account group by name, including its privilege set and members. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Get one Jamf Pro administrator account by ID, including its access level, privilege set and site assignment. Find the ID with jamf_classic_list_accounts. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Get one Jamf Pro administrator account by user name, including its access level, privilege set and site assignment. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] List every Jamf Pro administrator account and account group. This returns names and IDs only; use jamf_classic_get_accounts_userid or jamf_get_accounts for one account privileges. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Replace a Jamf Pro account group by ID. The Classic API replaces the whole record, so omitted members and privileges are cleared, and every member access changes with it. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Replace a Jamf Pro account group by name. The Classic API replaces the whole record, so omitted members and privileges are cleared, and every member access changes with it. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

[Jamf Pro] Replace a Jamf Pro administrator account by ID. The Classic API replaces the whole record, so a field you omit is cleared, and the account privileges and site can change. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Replace a Jamf Pro administrator account by user name. The Classic API replaces the whole record, so a field you omit is cleared, and the account privileges and site can change. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Api Integrations

ToolPlanAccessSummary
jamf_create_api_integrationsProDestructiveCreate a Jamf Pro API integration.
jamf_create_api_integrations_client_credentialsProDestructiveMint a new client secret for a Jamf Pro API integration.
jamf_delete_api_integrationsProDestructiveDelete a Jamf Pro API integration by ID.
jamf_get_api_integrationsFreeRead-onlyGet one Jamf Pro API integration by ID, including the API roles it holds and its access token lifetime.
jamf_list_api_integrationsFreeRead-onlyList the Jamf Pro API integrations, the API clients that hold client credentials for machine access to this Jamf Pro server.
jamf_update_api_integrationsProDestructiveUpdate a Jamf Pro API integration by ID.

[Jamf Pro] Create a Jamf Pro API integration. This defines a new machine identity for this Jamf Pro server; call jamf_create_api_integrations_client_credentials afterwards to mint its secret. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Mint a new client secret for a Jamf Pro API integration. The secret is returned once and cannot be read again, and minting a new one invalidates the previous secret. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of api integration object

[Jamf Pro] Delete a Jamf Pro API integration by ID. Every client credential issued to it stops working at once, so any automation that uses it breaks. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of api integration object

[Jamf Pro] Get one Jamf Pro API integration by ID, including the API roles it holds and its access token lifetime. Find the ID with jamf_list_api_integrations. The client secret is never returned.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of api integration object

[Jamf Pro] List the Jamf Pro API integrations, the API clients that hold client credentials for machine access to this Jamf Pro server. Secrets are never returned. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter app titles collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, displayName. Example: displayName=="IntegrationName"
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the query: id, displayName. Example: sort=displayName:desc

[Jamf Pro] Update a Jamf Pro API integration by ID. Changing the API roles it holds widens or narrows what that machine identity may do. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of api integration object

Api Role Privileges

ToolPlanAccessSummary
jamf_list_api_role_privilegesFreeRead-onlyList every privilege name a Jamf Pro API role can grant.
jamf_list_api_role_privileges_searchFreeRead-onlySearch the Jamf Pro API role privilege names.

[Jamf Pro] List every privilege name a Jamf Pro API role can grant. Use these names when you build a role with jamf_create_api_roles.

[Jamf Pro] Search the Jamf Pro API role privilege names. Use it to find the exact privilege string to put in an API role. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
limitstringnonullLimit the query results, defaults to 15
namestringyesThe partial or complete privilege name we are searching for

Api Roles

ToolPlanAccessSummary
jamf_create_api_rolesProDestructiveCreate a Jamf Pro API role from a list of privilege names.
jamf_delete_api_rolesProDestructiveDelete a Jamf Pro API role by ID.
jamf_get_api_rolesFreeRead-onlyGet one Jamf Pro API role by ID, including every privilege it grants.
jamf_list_api_rolesFreeRead-onlyList the Jamf Pro API roles, the named privilege sets that API integrations hold.
jamf_update_api_rolesProDestructiveUpdate a Jamf Pro API role by ID.

[Jamf Pro] Create a Jamf Pro API role from a list of privilege names. Get valid privilege names from jamf_list_api_role_privileges. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete a Jamf Pro API role by ID. Every API integration that holds it loses those privileges at once. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of API role

[Jamf Pro] Get one Jamf Pro API role by ID, including every privilege it grants. Find the ID with jamf_list_api_roles.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of API role

[Jamf Pro] List the Jamf Pro API roles, the named privilege sets that API integrations hold. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter app titles collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, displayName. Example: displayName=="myRole"
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Fields allowed in the query: id, displayName. Example: sort=displayName:desc

[Jamf Pro] Update a Jamf Pro API role by ID. Every API integration that holds this role gains or loses the privileges you change. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of API role

Apple Device Users Session Tokens

ToolPlanAccessSummary
jamf_list_adue_session_token_settingsFreeRead-onlyGet the Account Driven User Enrollment session token settings, which control how long an enrollment session token stays valid.
jamf_update_adue_session_token_settingsProDestructiveReplace the Account Driven User Enrollment session token settings.

[Jamf Pro] Replace the Account Driven User Enrollment session token settings. Shortening or disabling the token lifetime changes how users enroll their own devices. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Certificate Authorities

ToolPlanAccessSummary
jamf_create_pki_adcs_settingsProDestructiveCreate an AD CS certificate authority configuration and start its renewal monitor.
jamf_create_pki_adcs_settings_historyProWriteAdd a note to an AD CS certificate authority history.
jamf_create_pki_adcs_settings_validate_certificateProWriteValidate the file format of an AD CS server certificate.
jamf_create_pki_adcs_settings_validate_client_certificateProWriteValidate the file format and password of an AD CS client certificate.
jamf_create_pki_digicert_trust_lifecycle_managerProDestructiveCreate a DigiCert Trust Lifecycle Manager configuration and start its renewal monitor.
jamf_create_pki_digicert_trust_lifecycle_manager_validate_clientProWriteValidate the file format and password of a DigiCert client certificate.
jamf_create_pki_venafiProDestructiveCreate a Venafi certificate authority configuration.
jamf_create_pki_venafi_historyProWriteAdd a note to a Venafi certificate authority history.
jamf_create_pki_venafi_jamf_public_key_regenerateProDestructiveRegenerate the certificate Jamf Pro presents to a Jamf Pro PKI Proxy Server.
jamf_create_pki_venafi_proxy_trust_storeProDestructiveUpload the PKI Proxy Server public key that Jamf Pro will trust for TLS validation.
jamf_delete_pki_adcs_settingsProDestructiveDelete an AD CS certificate authority configuration by ID.
jamf_delete_pki_digicert_trust_lifecycle_managerProDestructiveDelete a DigiCert Trust Lifecycle Manager configuration by ID.
jamf_delete_pki_venafiProDestructiveDelete a Venafi certificate authority configuration by ID.
jamf_delete_pki_venafi_proxy_trust_storeProDestructiveRemove the PKI Proxy Server public key Jamf Pro trusts.
jamf_get_pki_adcs_settingsFreeRead-onlyGet one AD CS certificate authority configuration by ID.
jamf_get_pki_certificate_authorityFreeRead-onlyGet the X.509 details of one certificate authority by ID.
jamf_get_pki_digicert_trust_lifecycle_managerFreeRead-onlyGet the DigiCert Trust Lifecycle Manager configuration by ID.
jamf_get_pki_venafiFreeRead-onlyGet one Venafi certificate authority configuration by ID.
jamf_list_pki_adcs_settings_dependenciesFreeRead-onlyList the configuration profiles that depend on one AD CS certificate authority.
jamf_list_pki_adcs_settings_historyFreeRead-onlyGet the change history and notes recorded against one AD CS certificate authority configuration.
jamf_list_pki_certificate_authority_activeFreeRead-onlyGet the X.509 details of the certificate authority Jamf Pro currently issues device certificates from.
jamf_list_pki_certificate_authority_active_pemFreeRead-onlyDownload the active certificate authority in PEM format.
jamf_list_pki_certificate_authority_pemFreeRead-onlyDownload one certificate authority in PEM format by ID.
jamf_list_pki_digicert_trust_lifecycle_manager_connection_statusFreeRead-onlyTest the connection between Jamf Pro and DigiCert Trust Lifecycle Manager.
jamf_list_pki_digicert_trust_lifecycle_manager_dependenciesFreeRead-onlyList the configuration profiles that depend on a DigiCert Trust Lifecycle Manager configuration.
jamf_list_pki_digicert_trust_lifecycle_manager_privilege_checkFreeRead-onlyCheck whether the DigiCert account Jamf Pro uses holds the permissions needed to deploy certificates.
jamf_list_pki_venafi_connection_statusFreeRead-onlyTest the connection between Jamf Pro and a Jamf Pro PKI Proxy Server.
jamf_list_pki_venafi_dependent_profilesFreeRead-onlyList the configuration profiles that use one Venafi certificate authority.
jamf_list_pki_venafi_historyFreeRead-onlyGet the change history and notes recorded against one Venafi certificate authority configuration.
jamf_list_pki_venafi_jamf_public_keyFreeRead-onlyDownload the certificate Jamf Pro presents to a Jamf Pro PKI Proxy Server.
jamf_list_pki_venafi_proxy_trust_storeFreeRead-onlyDownload the PKI Proxy Server public key that Jamf Pro trusts.
jamf_patch_pki_adcs_settingsProWriteUpdate an AD CS certificate authority configuration.
jamf_patch_pki_digicert_trust_lifecycle_managerProWriteUpdate a DigiCert Trust Lifecycle Manager configuration.
jamf_patch_pki_venafiProDestructiveUpdate a Venafi certificate authority configuration by ID.

[Jamf Pro] Create an AD CS certificate authority configuration and start its renewal monitor. Jamf Pro can then issue device certificates from it, and the inbound or outbound mode cannot be changed afterwards. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Add a note to an AD CS certificate authority history. The note is an audit record only; it changes no configuration. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesInstance ID of AD CS Settings history record.

[Jamf Pro] Validate the file format of an AD CS server certificate. Send base64 encoded X.509 content. Nothing is stored. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Validate the file format and password of an AD CS client certificate. Send base64 encoded PKCS 12 content holding a single X.509 certificate. Nothing is stored. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Create a DigiCert Trust Lifecycle Manager configuration and start its renewal monitor. Jamf Pro can then issue device certificates through DigiCert. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Validate the file format and password of a DigiCert client certificate. Send base64 encoded PKCS 12 content. Nothing is stored. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Create a Venafi certificate authority configuration. Jamf Pro can then issue device certificates through Venafi. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Add a note to a Venafi certificate authority history. The note is an audit record only; it changes no configuration. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of Venafi CA history record

[Jamf Pro] Regenerate the certificate Jamf Pro presents to a Jamf Pro PKI Proxy Server. The proxy stops trusting Jamf Pro until an operator installs the new public key. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID of the Venafi configuration

[Jamf Pro] Upload the PKI Proxy Server public key that Jamf Pro will trust for TLS validation. This changes which proxy Jamf Pro accepts. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesID of the Venafi configuration

[Jamf Pro] Delete an AD CS certificate authority configuration by ID. Jamf Pro refuses while configuration profiles still use it, so check jamf_list_pki_adcs_settings_dependencies first. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID of the AD CS Settings configuration.

[Jamf Pro] Delete a DigiCert Trust Lifecycle Manager configuration by ID. Certificate issuance through DigiCert stops, so check jamf_list_pki_digicert_trust_lifecycle_manager_dependencies first. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID of the DigiCert Trust Lifecycle Manager configuration

[Jamf Pro] Delete a Venafi certificate authority configuration by ID. Certificate issuance through Venafi stops, so check jamf_list_pki_venafi_dependent_profiles first. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID of the Venafi configuration

[Jamf Pro] Remove the PKI Proxy Server public key Jamf Pro trusts. TLS validation between Jamf Pro and the proxy stops working until a new key is uploaded. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID of the Venafi configuration

[Jamf Pro] Get one AD CS certificate authority configuration by ID. Public key information is returned; no password is.

ParamTypeRequiredDefaultDescription
idstringyesID of the AD CS Settings configuration.
ParamTypeRequiredDefaultDescription
idstringyesUUID of the Certificate Authority (CA)
ParamTypeRequiredDefaultDescription
idstringyesID of the DigiCert Trust Lifecycle Manager configuration
ParamTypeRequiredDefaultDescription
idstringyesID of the Venafi configuration

[Jamf Pro] List the configuration profiles that depend on one AD CS certificate authority. Check this before you delete it.

ParamTypeRequiredDefaultDescription
idstringyesAD CS Settings ID

[Jamf Pro] Get the change history and notes recorded against one AD CS certificate authority configuration. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15
idstringyesID of the AD CS Settings configuration.
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Download the active certificate authority in PEM format. This is public certificate material, not a private key.

[Jamf Pro] Download one certificate authority in PEM format by ID. This is public certificate material, not a private key.

ParamTypeRequiredDefaultDescription
idstringyesUUID of the Certificate Authority (CA)

[Jamf Pro] Test the connection between Jamf Pro and DigiCert Trust Lifecycle Manager. This is a health probe and changes no configuration.

ParamTypeRequiredDefaultDescription
idstringyesID of the DigiCert Trust Lifecycle Manager settings.

[Jamf Pro] List the configuration profiles that depend on a DigiCert Trust Lifecycle Manager configuration. Check this before you delete it.

ParamTypeRequiredDefaultDescription
idstringyesID of the DigiCert Trust Lifecycle Manager configuration.
ParamTypeRequiredDefaultDescription
idstringyesID of the DigiCert Trust Lifecycle Manager settings.

[Jamf Pro] Test the connection between Jamf Pro and a Jamf Pro PKI Proxy Server. This is a health probe and changes no configuration.

ParamTypeRequiredDefaultDescription
idstringyesID of the Venafi configuration

[Jamf Pro] List the configuration profiles that use one Venafi certificate authority. Check this before you delete it.

ParamTypeRequiredDefaultDescription
idstringyesID of the Venafi configuration

[Jamf Pro] Get the change history and notes recorded against one Venafi certificate authority configuration. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15
idstringyesID of the Venafi configuration
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Download the certificate Jamf Pro presents to a Jamf Pro PKI Proxy Server. This is public certificate material, not a private key.

ParamTypeRequiredDefaultDescription
idstringyesID of the Venafi configuration

[Jamf Pro] Download the PKI Proxy Server public key that Jamf Pro trusts. This is public certificate material, not a private key.

ParamTypeRequiredDefaultDescription
idstringyesID of the Venafi configuration

[Jamf Pro] Update an AD CS certificate authority configuration. Only the fields you send change, certificate information must be sent in full or left out entirely, and the inbound or outbound mode cannot change. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesID of the AD CS Settings configuration.

[Jamf Pro] Update a DigiCert Trust Lifecycle Manager configuration. Only the fields you send change, and client certificate information must be sent in full or left out entirely. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesID of the DigiCert Trust Lifecycle Manager configuration.

[Jamf Pro] Update a Venafi certificate authority configuration by ID. This endpoint takes plain JSON rather than a merge patch, so treat it as a change to trust material and confirm the fields you send. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesID of the Venafi configuration

Cloud Identity Providers

ToolPlanAccessSummary
jamf_create_cloud_idp_historyProWriteAdd a note to a cloud identity provider history.
jamf_create_cloud_idp_test_groupProWriteRun a test group lookup against a configured cloud identity provider to confirm its search base and mappings.
jamf_create_cloud_idp_test_userProWriteRun a test user lookup against a configured cloud identity provider to confirm its search base and mappings.
jamf_create_cloud_idp_test_user_membershipProWriteRun a test membership lookup against a configured cloud identity provider to confirm that group membership resolves.
jamf_export_cloud_idpFreeRead-onlyExport the cloud identity provider list as a report.
jamf_get_cloud_idpFreeRead-onlyGet one cloud identity provider configuration by ID.
jamf_list_cloud_idpFreeRead-onlyList every cloud identity provider configured in Jamf Pro.
jamf_list_cloud_idp_historyFreeRead-onlyGet the change history and notes recorded against one cloud identity provider.

[Jamf Pro] Add a note to a cloud identity provider history. The note is an audit record only; it changes no configuration and reaches nobody. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesCloud Identity Provider identifier

[Jamf Pro] Run a test group lookup against a configured cloud identity provider to confirm its search base and mappings. The lookup reads the directory and changes nothing. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesCloud Identity Provider identifier

[Jamf Pro] Run a test user lookup against a configured cloud identity provider to confirm its search base and mappings. The lookup reads the directory and changes nothing. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesCloud Identity Provider identifier

[Jamf Pro] Run a test membership lookup against a configured cloud identity provider to confirm that group membership resolves. The lookup reads the directory and changes nothing. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesCloud Identity Provider identifier

[Jamf Pro] Export the cloud identity provider list as a report. This reads the collection and changes nothing. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
exportFieldsstringnonullExport fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username
exportLabelsstringnonullExport labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username
fieldsJsonstringyesJSON object request body.
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name. This param can be combined with paging and sorting. Example: name=="department"
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be seperated with a comma. Example: sort=id:desc,name:asc

[Jamf Pro] Get one cloud identity provider configuration by ID. Find the ID with jamf_list_cloud_idp.

ParamTypeRequiredDefaultDescription
idstringyesCloud Identity Provider identifier

[Jamf Pro] List every cloud identity provider configured in Jamf Pro. Use jamf_get_cloud_idp for one provider full record. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Get the change history and notes recorded against one cloud identity provider. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15
idstringyesCloud Identity Provider identifier
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

Cloud LDAP

ToolPlanAccessSummary
jamf_create_cloud_ldapsProDestructiveCreate a cloud identity provider configuration.
jamf_delete_cloud_ldapsProDestructiveDelete a cloud identity provider configuration by ID.
jamf_get_cloud_ldapsFreeRead-onlyGet one cloud identity provider configuration by ID through the LDAP surface, including server settings and keystore details.
jamf_list_cloud_ldaps_connection_bindFreeRead-onlyGet bind connection pool statistics for a cloud identity provider.
jamf_list_cloud_ldaps_connection_searchFreeRead-onlyGet search connection pool statistics for a cloud identity provider.
jamf_list_cloud_ldaps_connection_statusFreeRead-onlyTest the connection between Jamf Pro and a cloud identity provider.
jamf_list_cloud_ldaps_defaults_mappingsFreeRead-onlyGet the default attribute mappings Jamf Pro suggests for a cloud identity provider type.
jamf_list_cloud_ldaps_defaults_server_configurationFreeRead-onlyGet the default server configuration Jamf Pro suggests for a cloud identity provider type.
jamf_list_cloud_ldaps_mappingsFreeRead-onlyGet the attribute mappings of one cloud identity provider, the fields Jamf Pro reads for user and group lookups.
jamf_update_cloud_ldapsProDestructiveUpdate a cloud identity provider configuration by ID.
jamf_update_cloud_ldaps_mappingsProDestructiveReplace the attribute mappings of a cloud identity provider.

[Jamf Pro] Create a cloud identity provider configuration. This connects Jamf Pro to an external directory, so it changes which people Jamf Pro can authenticate and scope to. Jamf Pro generates default mappings when you omit them. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete a cloud identity provider configuration by ID. Every Jamf Pro scope, policy and login that resolves through this directory stops resolving. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesCloud Identity Provider identifier
ParamTypeRequiredDefaultDescription
idstringyesCloud Identity Provider identifier

[Jamf Pro] Get bind connection pool statistics for a cloud identity provider. Use it when directory lookups are slow or intermittent.

ParamTypeRequiredDefaultDescription
idstringyesCloud Identity Provider identifier

[Jamf Pro] Get search connection pool statistics for a cloud identity provider. Use it when directory lookups are slow or intermittent.

ParamTypeRequiredDefaultDescription
idstringyesCloud Identity Provider identifier

[Jamf Pro] Test the connection between Jamf Pro and a cloud identity provider. This is a health probe and changes no configuration.

ParamTypeRequiredDefaultDescription
idstringyesCloud Identity Provider identifier

[Jamf Pro] Get the default attribute mappings Jamf Pro suggests for a cloud identity provider type. The provider path parameter is the provider name, for example GOOGLE or AZURE.

ParamTypeRequiredDefaultDescription
providerstringyesCloud Identity Provider name

[Jamf Pro] Get the default server configuration Jamf Pro suggests for a cloud identity provider type. The provider path parameter is the provider name, for example GOOGLE or AZURE.

ParamTypeRequiredDefaultDescription
providerstringyesCloud Identity Provider name
ParamTypeRequiredDefaultDescription
idstringyesCloud Identity Provider identifier

[Jamf Pro] Update a cloud identity provider configuration by ID. Changing the server settings changes which people Jamf Pro can authenticate. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesCloud Identity Provider identifier

[Jamf Pro] Replace the attribute mappings of a cloud identity provider. Wrong mappings stop user and group lookups from resolving, which breaks every scope that depends on them. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesCloud Identity Provider identifier

Conditional Access

ToolPlanAccessSummary
jamf_get_conditional_access_device_compliance_info_computerFreeRead-onlyGet the conditional access compliance state Jamf Pro reports for one Mac.
jamf_get_conditional_access_device_compliance_information_mobileFreeRead-onlyGet the conditional access compliance state Jamf Pro reports for one mobile device.
jamf_list_conditional_access_device_compliance_feature_toggleFreeRead-onlyGet whether the device compliance feature is turned on for this Jamf Pro server.

[Jamf Pro] Get the conditional access compliance state Jamf Pro reports for one Mac. The deviceId path parameter is the Jamf Pro computer ID.

ParamTypeRequiredDefaultDescription
deviceIdstringyesID of the device the query pertains

[Jamf Pro] Get the conditional access compliance state Jamf Pro reports for one mobile device. The deviceId path parameter is the Jamf Pro mobile device ID.

ParamTypeRequiredDefaultDescription
deviceIdstringyesID of the device the query pertains

Infrastructure Manager (Classic API)

ToolPlanAccessSummary
jamf_classic_get_infrastructuremanager_idFreeRead-onlyGet one Jamf Infrastructure Manager by ID.
jamf_classic_list_infrastructuremanagerFreeRead-onlyList the Jamf Infrastructure Managers registered with this Jamf Pro server.
jamf_classic_update_infrastructuremanager_idProDestructiveReplace a Jamf Infrastructure Manager record by ID.

[Jamf Pro] Get one Jamf Infrastructure Manager by ID. Find the ID with jamf_classic_list_infrastructuremanager. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] List the Jamf Infrastructure Managers registered with this Jamf Pro server. These proxy LDAP and other on-premises traffic. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Replace a Jamf Infrastructure Manager record by ID. The Classic API replaces the whole record, so an omitted field is cleared and on-premises directory traffic can stop routing. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

Jamf Cloud Services Connection

ToolPlanAccessSummary
jamf_delete_csa_tokenProDestructiveDelete the Jamf Cloud Services token exchange.
jamf_list_csa_tenant_idFreeRead-onlyGet the Jamf Cloud Services tenant ID of this Jamf Pro server.
jamf_list_csa_tokenFreeRead-onlyGet the status of the Jamf Cloud Services token exchange, which lets Jamf Pro authenticate to Jamf hosted services.

[Jamf Pro] Delete the Jamf Cloud Services token exchange. Jamf Pro loses its ability to authenticate to cloud hosted Jamf services at once, and re-establishing it needs an operator to sign in again. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

[Jamf Pro] Get the status of the Jamf Cloud Services token exchange, which lets Jamf Pro authenticate to Jamf hosted services. The token value itself is not returned.

Jamf Pro User (Classic API)

ToolPlanAccessSummary
jamf_classic_list_jssuserFreeRead-onlyGet basic Jamf Pro server information and the privileges of the account whose credentials this connection uses.

[Jamf Pro] Get basic Jamf Pro server information and the privileges of the account whose credentials this connection uses. On current Jamf Pro versions prefer jamf_list_api_role_privileges. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

JSON Web Token Configurations (Classic API)

ToolPlanAccessSummary
jamf_classic_create_jsonwebtokenconfigurations_idProDestructiveCreate a JSON Web Token configuration.
jamf_classic_delete_jsonwebtokenconfigurations_idProDestructiveDelete a JSON Web Token configuration by ID.
jamf_classic_get_jsonwebtokenconfigurations_idFreeRead-onlyGet one JSON Web Token configuration by ID.
jamf_classic_list_jsonwebtokenconfigurationsFreeRead-onlyList the JSON Web Token configurations, the signing keys Jamf Pro trusts for token based integrations.
jamf_classic_update_jsonwebtokenconfigurations_idProDestructiveReplace a JSON Web Token configuration by ID.

[Jamf Pro] Create a JSON Web Token configuration. Jamf Pro will trust tokens signed with the key in the XML document, so this grants a new integration access. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Delete a JSON Web Token configuration by ID. Every integration that signs tokens with that key stops being trusted. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Get one JSON Web Token configuration by ID. Find the ID with jamf_classic_list_jsonwebtokenconfigurations. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] List the JSON Web Token configurations, the signing keys Jamf Pro trusts for token based integrations. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Replace a JSON Web Token configuration by ID. The Classic API replaces the whole record, and changing the signing key changes which tokens Jamf Pro trusts. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

Last Login

ToolPlanAccessSummary
jamf_list_last_loginFreeRead-onlyGet the date of the most recent Jamf Pro login event.

LDAP

ToolPlanAccessSummary
jamf_list_ldap_groupsFreeRead-onlySearch the configured directory access groups by name.
jamf_list_ldap_ldap_serversFreeRead-onlyList the LDAP servers configured in Jamf Pro.
jamf_list_ldap_serversFreeRead-onlyList every directory Jamf Pro can query, both LDAP servers and cloud identity providers.

[Jamf Pro] Search the configured directory access groups by name. Use it to confirm a group resolves before you scope anything to it.

ParamTypeRequiredDefaultDescription
qstringnonullWill perform a "contains" search on the names of access groups

LDAP (Classic)

ToolPlanAccessSummary
jamf_get_classic_ldapFreeRead-onlyGet the attribute mappings of an on-premises LDAP configuration by ID.

[Jamf Pro] Get the attribute mappings of an on-premises LDAP configuration by ID. Find the ID with jamf_classic_list_ldapservers.

ParamTypeRequiredDefaultDescription
idstringyesOnPrem Ldap identifier

LDAP Keystore

ToolPlanAccessSummary
jamf_create_ldap_keystore_verifyProWriteValidate a keystore for a secure cloud identity provider connection.

[Jamf Pro] Validate a keystore for a secure cloud identity provider connection. This checks the file and password only; nothing is stored. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

LDAP Servers (Classic API)

ToolPlanAccessSummary
jamf_classic_create_ldapservers_idProDestructiveCreate an LDAP server configuration.
jamf_classic_delete_ldapservers_idProDestructiveDelete an LDAP server configuration by ID.
jamf_classic_delete_ldapservers_nameProDestructiveDelete an LDAP server configuration by name.
jamf_classic_get_ldapservers_idFreeRead-onlyGet one LDAP server configuration by ID, including its connection and mapping settings.
jamf_classic_get_ldapservers_id_groupFreeRead-onlyLook up groups on an LDAP server addressed by ID.
jamf_classic_get_ldapservers_id_group_userFreeRead-onlyCheck whether a user belongs to a group on an LDAP server addressed by ID.
jamf_classic_get_ldapservers_id_userFreeRead-onlyLook up users on an LDAP server addressed by ID.
jamf_classic_get_ldapservers_nameFreeRead-onlyGet one LDAP server configuration by name, including its connection and mapping settings.
jamf_classic_get_ldapservers_name_groupFreeRead-onlyLook up groups on an LDAP server addressed by name.
jamf_classic_get_ldapservers_name_group_userFreeRead-onlyCheck whether a user belongs to a group on an LDAP server addressed by name.
jamf_classic_get_ldapservers_name_userFreeRead-onlyLook up users on an LDAP server addressed by name.
jamf_classic_list_ldapserversFreeRead-onlyList the LDAP servers configured in Jamf Pro, with their IDs and names.
jamf_classic_update_ldapservers_idProDestructiveReplace an LDAP server configuration by ID.
jamf_classic_update_ldapservers_nameProDestructiveReplace an LDAP server configuration by name.

[Jamf Pro] Create an LDAP server configuration. This connects Jamf Pro to a directory, so it changes which people Jamf Pro can authenticate and scope to. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Delete an LDAP server configuration by ID. Every Jamf Pro scope and login that resolves through this directory stops resolving. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Delete an LDAP server configuration by name. Every Jamf Pro scope and login that resolves through this directory stops resolving. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Get one LDAP server configuration by ID, including its connection and mapping settings. Find the ID with jamf_classic_list_ldapservers. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Look up groups on an LDAP server addressed by ID. Use it to confirm a group resolves before you scope anything to it. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
groupstringyesGroup to filter by
idstringyesServer ID to filter by

[Jamf Pro] Check whether a user belongs to a group on an LDAP server addressed by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
groupstringyesGroup to filter by
idstringyesServer ID to filter by
userstringyesUser to filter by

[Jamf Pro] Look up users on an LDAP server addressed by ID. Use it to confirm a user resolves before you scope anything to them. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesServer ID to filter by
userstringyesUser to filter by

[Jamf Pro] Get one LDAP server configuration by name, including its connection and mapping settings. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Look up groups on an LDAP server addressed by name. Use it to confirm a group resolves before you scope anything to it. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
groupstringyesGroup to filter by
namestringyesServer name to filter by

[Jamf Pro] Check whether a user belongs to a group on an LDAP server addressed by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
groupstringyesGroup to filter by
namestringyesServer name to filter by
userstringyesUser to filter by

[Jamf Pro] Look up users on an LDAP server addressed by name. Use it to confirm a user resolves before you scope anything to them. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesServer name to filter by
userstringyesUser to filter by

[Jamf Pro] List the LDAP servers configured in Jamf Pro, with their IDs and names. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Replace an LDAP server configuration by ID. The Classic API replaces the whole record, so an omitted field is cleared and directory logins can stop working. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Replace an LDAP server configuration by name. The Classic API replaces the whole record, so an omitted field is cleared and directory logins can stop working. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Machine-to-Machine Authentication

ToolPlanAccessSummary
jamf_list_m2m_tenant_idFreeRead-onlyGet the machine to machine tenant ID of this Jamf Pro server.

Microsoft Entra Integration

ToolPlanAccessSummary
jamf_create_cloud_azureProDestructiveCreate an Azure cloud identity provider configuration.
jamf_delete_cloud_azureProDestructiveDelete a cloud identity provider configuration by ID.
jamf_get_cloud_azureFreeRead-onlyGet one Azure cloud identity provider configuration by ID, including its server settings and attribute mappings.
jamf_list_cloud_azure_defaults_mappingsFreeRead-onlyGet the default Azure attribute mappings Jamf Pro suggests.
jamf_list_cloud_azure_defaults_server_configurationFreeRead-onlyGet the default Azure server configuration Jamf Pro suggests.
jamf_update_cloud_azureProDestructiveUpdate an Azure cloud identity provider configuration by ID.

[Jamf Pro] Create an Azure cloud identity provider configuration. This connects Jamf Pro to an Azure directory, so it changes which people Jamf Pro can authenticate and scope to. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete a cloud identity provider configuration by ID. Every Jamf Pro scope, policy and login that resolves through this directory stops resolving. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesCloud Identity Provider identifier
ParamTypeRequiredDefaultDescription
idstringyesCloud Identity Provider identifier

[Jamf Pro] Get the default Azure attribute mappings Jamf Pro suggests. Use them as the starting point for jamf_create_cloud_azure. Jamf documents this operation as deprecated; prefer a newer equivalent where one exists.

[Jamf Pro] Get the default Azure server configuration Jamf Pro suggests. Use it as the starting point for jamf_create_cloud_azure.

[Jamf Pro] Update an Azure cloud identity provider configuration by ID. Changing the server settings or attribute mappings changes which people Jamf Pro can authenticate and how their groups resolve. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesCloud Identity Provider identifier

Network Segments (Classic API)

ToolPlanAccessSummary
jamf_classic_create_networksegments_idProWriteCreate a network segment.
jamf_classic_delete_networksegments_idProDestructiveDelete a network segment by ID.
jamf_classic_delete_networksegments_nameProDestructiveDelete a network segment by name.
jamf_classic_get_networksegments_idFreeRead-onlyGet one network segment by ID, including its IP range and the building and department it assigns.
jamf_classic_get_networksegments_nameFreeRead-onlyGet one network segment by name, including its IP range and the building and department it assigns.
jamf_classic_list_networksegmentsFreeRead-onlyList the network segments, the IP ranges Jamf Pro uses to scope policies and to set a device building and department.
jamf_classic_update_networksegments_idProDestructiveReplace a network segment by ID.
jamf_classic_update_networksegments_nameProDestructiveReplace a network segment by name.

[Jamf Pro] Create a network segment. A new IP range takes effect for scoping only when a policy or profile refers to it. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Delete a network segment by ID. Every policy and profile scoped to that IP range loses the limitation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Delete a network segment by name. Every policy and profile scoped to that IP range loses the limitation. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Get one network segment by ID, including its IP range and the building and department it assigns. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Get one network segment by name, including its IP range and the building and department it assigns. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] List the network segments, the IP ranges Jamf Pro uses to scope policies and to set a device building and department. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Replace a network segment by ID. The Classic API replaces the whole record, so an omitted field is cleared, and changing the IP range changes which devices fall inside every scope that uses it. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Replace a network segment by name. The Classic API replaces the whole record, so an omitted field is cleared, and changing the IP range changes which devices fall inside every scope that uses it. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

OpenID Connect

ToolPlanAccessSummary
jamf_create_oidc_generate_certificateProDestructiveGenerate a new keystore for signing OpenID Connect messages.
jamf_dispatch_oidcProWriteGet the redirect URL for an OpenID Connect sign in from an email address.
jamf_list_oidc_direct_idp_login_urlFreeRead-onlyGet the URL that sends a user straight to the identity provider for OpenID Connect sign in.
jamf_list_oidc_public_featuresFreeRead-onlyGet the OpenID Connect features this Jamf Pro server advertises publicly.
jamf_list_oidc_public_keyFreeRead-onlyGet the public key of the keystore Jamf Pro uses to sign OpenID Connect messages, as a JSON Web Token.

[Jamf Pro] Generate a new keystore for signing OpenID Connect messages. The previous signing key stops being used, so any relying party pinned to it must take the new public key. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

[Jamf Pro] Get the redirect URL for an OpenID Connect sign in from an email address. This resolves the URL and changes no state. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Get the public key of the keystore Jamf Pro uses to sign OpenID Connect messages, as a JSON Web Token. This is public key material, not a secret.

Removable MAC Addresses (Classic API)

ToolPlanAccessSummary
jamf_classic_create_removablemacaddresses_idProWriteAdd a MAC address for Jamf Pro to ignore during inventory.
jamf_classic_delete_removablemacaddresses_idProDestructiveDelete an ignored MAC address by ID.
jamf_classic_delete_removablemacaddresses_nameProDestructiveDelete an ignored MAC address by name.
jamf_classic_get_removablemacaddresses_idFreeRead-onlyGet one ignored MAC address by ID.
jamf_classic_get_removablemacaddresses_nameFreeRead-onlyGet one ignored MAC address by name.
jamf_classic_list_removablemacaddressesFreeRead-onlyList the MAC addresses Jamf Pro ignores during inventory, normally shared adapters and docks.
jamf_classic_update_removablemacaddresses_idProDestructiveReplace an ignored MAC address record by ID.
jamf_classic_update_removablemacaddresses_nameProDestructiveReplace an ignored MAC address record by name.

[Jamf Pro] Add a MAC address for Jamf Pro to ignore during inventory. Existing records are untouched. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Delete an ignored MAC address by ID. Jamf Pro starts recording that address in inventory again, which can merge unrelated devices onto one record. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Delete an ignored MAC address by name. Jamf Pro starts recording that address in inventory again, which can merge unrelated devices onto one record. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Get one ignored MAC address by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Get one ignored MAC address by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] List the MAC addresses Jamf Pro ignores during inventory, normally shared adapters and docks. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Replace an ignored MAC address record by ID. The Classic API replaces the whole record, so an omitted field is cleared. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Replace an ignored MAC address record by name. The Classic API replaces the whole record, so an omitted field is cleared. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Single Sign-On

ToolPlanAccessSummary
jamf_create_sso_certProDestructiveHave Jamf Pro generate a new certificate and start signing single sign on requests with it.
jamf_create_sso_cert_parseProWriteParse a certificate file to report its type and the keys needed to upload it.
jamf_create_sso_failover_generateProDestructiveRegenerate the single sign on failover URL.
jamf_create_sso_historyProWriteAdd a note to the single sign on history.
jamf_delete_sso_certProDestructiveDelete the certificate configured for single sign on.
jamf_disable_ssoProDestructiveTurn single sign on off.
jamf_list_ssoFreeRead-onlyGet the current single sign on configuration of this Jamf Pro server.
jamf_list_sso_certFreeRead-onlyGet the certificate Jamf Pro uses to sign single sign on requests.
jamf_list_sso_cert_downloadFreeRead-onlyDownload the single sign on signing certificate.
jamf_list_sso_dependenciesFreeRead-onlyList the enrollment customizations that use single sign on.
jamf_list_sso_failoverFreeRead-onlyGet the current single sign on failover settings, including the failover URL that bypasses the identity provider.
jamf_list_sso_historyFreeRead-onlyGet the change history and notes recorded against the single sign on configuration.
jamf_list_sso_metadata_downloadFreeRead-onlyDownload the SAML metadata file for this Jamf Pro server.
jamf_update_ssoProDestructiveReplace the single sign on configuration.
jamf_update_sso_certProDestructiveReplace the certificate Jamf Pro uses to sign single sign on requests.

[Jamf Pro] Have Jamf Pro generate a new certificate and start signing single sign on requests with it. The identity provider rejects requests until it is given the new certificate. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

[Jamf Pro] Parse a certificate file to report its type and the keys needed to upload it. Nothing is stored. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Regenerate the single sign on failover URL. The previous failover URL stops working at once, so record the new one before anyone needs it. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

[Jamf Pro] Add a note to the single sign on history. The note is an audit record only; it changes no configuration. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete the certificate configured for single sign on. Signed single sign on requests stop working until a new certificate is configured. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

[Jamf Pro] Turn single sign on off. Users fall back to local Jamf Pro accounts, and anyone without one loses access. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

[Jamf Pro] Get the certificate Jamf Pro uses to sign single sign on requests. Public certificate details only.

[Jamf Pro] Download the single sign on signing certificate. This is public certificate material, not a private key.

[Jamf Pro] List the enrollment customizations that use single sign on. Check this before you disable it.

[Jamf Pro] Get the change history and notes recorded against the single sign on configuration. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Download the SAML metadata file for this Jamf Pro server. Give it to the identity provider when you set up the trust.

[Jamf Pro] Replace the single sign on configuration. A wrong identity provider setting can lock every administrator out of Jamf Pro, so keep the failover URL from jamf_list_sso_failover to hand before you run it. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Replace the certificate Jamf Pro uses to sign single sign on requests. The identity provider rejects requests until it is given the new certificate. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

Sites (Classic API)

ToolPlanAccessSummary
jamf_classic_create_sites_idProWriteCreate a Jamf Pro site.
jamf_classic_delete_sites_idProDestructiveDelete a Jamf Pro site by ID.
jamf_classic_delete_sites_nameProDestructiveDelete a Jamf Pro site by name.
jamf_classic_get_sites_idFreeRead-onlyGet one Jamf Pro site by ID.
jamf_classic_get_sites_nameFreeRead-onlyGet one Jamf Pro site by name.
jamf_classic_list_sitesFreeRead-onlyList the Jamf Pro sites, the boundaries that partition objects and administrator access.
jamf_classic_update_sites_idProDestructiveReplace a Jamf Pro site by ID.
jamf_classic_update_sites_nameProDestructiveReplace a Jamf Pro site by name.

[Jamf Pro] Create a Jamf Pro site. A new site owns nothing until objects and accounts are assigned to it. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Delete a Jamf Pro site by ID. Every object assigned to the site loses its site assignment and site scoped administrators lose that access. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Delete a Jamf Pro site by name. Every object assigned to the site loses its site assignment and site scoped administrators lose that access. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Get one Jamf Pro site by ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Get one Jamf Pro site by name. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] List the Jamf Pro sites, the boundaries that partition objects and administrator access. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Replace a Jamf Pro site by ID. The Classic API replaces the whole record, and renaming a site changes what site scoped administrators see. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Replace a Jamf Pro site by name. The Classic API replaces the whole record, and renaming a site changes what site scoped administrators see. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Software License Agreement

ToolPlanAccessSummary
jamf_create_slasaProDestructiveAccept the Jamf software license and services agreement on this server.
jamf_list_slasaFreeRead-onlyGet whether the Jamf software license and services agreement has been accepted on this server.

[Jamf Pro] Accept the Jamf software license and services agreement on this server. This records a legal acceptance on the customer behalf, so run it only when the customer has told you to. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

Supervision Identities

ToolPlanAccessSummary
jamf_create_supervision_identitiesProDestructiveCreate a supervision identity.
jamf_delete_supervision_identitiesProDestructiveDelete a supervision identity by ID.
jamf_get_supervision_identitiesFreeRead-onlyGet one supervision identity by ID.
jamf_list_supervision_identitiesFreeRead-onlyList the supervision identities, the signing identities Apple Configurator uses to supervise devices.
jamf_update_supervision_identitiesProDestructiveUpdate a supervision identity by ID.
jamf_upload_supervision_identitiesProDestructiveUpload a supervision identity p12 file.

[Jamf Pro] Create a supervision identity. Jamf Pro mints a signing identity that can supervise Apple devices. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Delete a supervision identity by ID. Devices supervised with it cannot be re-supervised until a new identity is in place. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesSupervision Identity identifier

[Jamf Pro] Get one supervision identity by ID. Find the ID with jamf_list_supervision_identities.

ParamTypeRequiredDefaultDescription
idstringyesSupervision Identity identifier

[Jamf Pro] List the supervision identities, the signing identities Apple Configurator uses to supervise devices. Paginated: page is zero-based and pageSize is capped at 200 by StackJack.

ParamTypeRequiredDefaultDescription
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Update a supervision identity by ID. Changing the identity changes which devices Apple Configurator can supervise with it. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesSupervision Identity identifier

[Jamf Pro] Upload a supervision identity p12 file. The file carries private key material, so send it only over this authenticated connection. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

User Sessions

ToolPlanAccessSummary
jamf_list_user_sessions_activeFreeRead-onlyList the administrator sessions currently signed in to Jamf Pro.
jamf_list_user_sessions_countFreeRead-onlyGet the number of administrator sessions currently signed in to Jamf Pro.

Advanced User Content Searches

ToolPlanAccessSummary
jamf_create_advanced_user_content_searchesProWriteCreates a saved advanced user content search over the apps and eBooks assigned to users.
jamf_delete_advanced_user_content_searchesProDestructiveDeletes a saved advanced user content search by its ID.
jamf_get_advanced_user_content_searchesFreeRead-onlyReturns one saved advanced user content search by its ID, with its criteria and the columns it displays.
jamf_list_advanced_user_content_searchesFreeRead-onlyLists the saved advanced user content searches.
jamf_update_advanced_user_content_searchesProDestructiveReplaces a saved advanced user content search by its ID.

[Jamf Pro] Creates a saved advanced user content search over the apps and eBooks assigned to users. This adds a new saved query and changes nothing that already exists. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Deletes a saved advanced user content search by its ID. The saved criteria are gone for everyone who used the search; the users and the content it matched are untouched. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of Advanced User Content Search record

[Jamf Pro] Returns one saved advanced user content search by its ID, with its criteria and the columns it displays. Find the ID with jamf_list_advanced_user_content_searches.

ParamTypeRequiredDefaultDescription
idstringyesid of target Advanced User Content Search

[Jamf Pro] Lists the saved advanced user content searches. An advanced user content search is a reusable saved query over the apps and eBooks assigned to users. Use jamf_get_advanced_user_content_searches to read one by ID.

[Jamf Pro] Replaces a saved advanced user content search by its ID. This is a whole-record replacement: criteria and display columns you leave out of the body are cleared, not kept. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesid of target Advanced User Content Search

Advanced User Searches (Classic API)

ToolPlanAccessSummary
jamf_classic_create_advancedusersearches_idProWriteCreates a saved advanced user search.
jamf_classic_delete_advancedusersearches_idProDestructiveDeletes a saved advanced user search by its numeric ID.
jamf_classic_delete_advancedusersearches_nameProDestructiveDeletes a saved advanced user search by its exact name.
jamf_classic_get_advancedusersearches_idFreeRead-onlyReturns one saved advanced user search by its numeric ID, with its criteria and the columns it displays.
jamf_classic_get_advancedusersearches_nameFreeRead-onlyReturns one saved advanced user search by its exact name.
jamf_classic_list_advancedusersearchesFreeRead-onlyLists the saved advanced user searches.
jamf_classic_update_advancedusersearches_idProDestructiveReplaces a saved advanced user search by its numeric ID.
jamf_classic_update_advancedusersearches_nameProDestructiveReplaces a saved advanced user search by its exact name.

[Jamf Pro] Creates a saved advanced user search. Send 0 as the ID to let Jamf Pro assign the next free one. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a saved advanced user search by its numeric ID. The saved criteria are gone; the user records it matched are untouched. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a saved advanced user search by its exact name. The saved criteria are gone; the user records it matched are untouched. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Returns one saved advanced user search by its numeric ID, with its criteria and the columns it displays. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Returns one saved advanced user search by its exact name. Use jamf_classic_get_advancedusersearches_id when you already have the numeric ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Lists the saved advanced user searches. These are the saved queries over user records; jamf_list_advanced_user_content_searches is the separate list of saved searches over the apps and eBooks assigned to users. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Replaces a saved advanced user search by its numeric ID. Criteria and display columns absent from the document are cleared. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Replaces a saved advanced user search by its exact name. Criteria and display columns absent from the document are cleared. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName to filter by

Buildings

ToolPlanAccessSummary
jamf_create_buildingsProWriteCreates a building.
jamf_create_buildings_historyProWriteAdds a note to a building's change history.
jamf_delete_buildingsProDestructiveDeletes one building by its ID.
jamf_delete_multiple_buildingsProDestructiveDeletes several buildings at once, by ID.
jamf_export_buildingsFreeRead-onlyExports the building list as CSV text rather than JSON.
jamf_export_buildings_historyFreeRead-onlyExports one building's change history as CSV text rather than JSON.
jamf_get_buildingsFreeRead-onlyReturns one building by its ID, with its street address.
jamf_list_buildingsFreeRead-onlyLists the buildings defined in Jamf Pro.
jamf_list_buildings_historyFreeRead-onlyReturns the change history of one building: who changed it, when, and the notes recorded against it.
jamf_update_buildingsProDestructiveReplaces a building by its ID.

[Jamf Pro] Creates a building. This adds a location value; assigning devices or users to it is a separate write on each record. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Adds a note to a building's change history. This records text against the building and changes no field on it. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of building history record

[Jamf Pro] Deletes one building by its ID. Every device and user assigned to it loses that location value, and smart groups and policies scoped by the building stop matching them. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of building record

[Jamf Pro] Deletes several buildings at once, by ID. Every device and user assigned to any of them loses that location value, and smart groups and policies scoped by those buildings stop matching them. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Exports the building list as CSV text rather than JSON. export-fields chooses the columns and export-labels renames them; the two lists must hold the same number of entries. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
exportFieldsstringnonullExport fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username
exportLabelsstringnonullExport labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username
fieldsJsonstringyesJSON object request body.
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name. This param can be combined with paging and sorting. Example: name=="buildings"
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=id:desc,name:asc

[Jamf Pro] Exports one building's change history as CSV text rather than JSON. export-fields chooses the columns and export-labels renames them; the two lists must hold the same number of entries. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*". Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
exportFieldsstringnonullExport fields parameter, used to change default order or ignore some of the response properties. Default is empty array, which means that all fields of the response entity will be serialized. Example: export-fields=id,username
exportLabelsstringnonullExport labels parameter, used to customize fieldnames/columns in the exported file. Default is empty array, which means that response properties names will be used. Number of the provided labels must match the number of export-fields Example: export-labels=identifier,name with matching: export-fields=id,username
fieldsJsonstringyesJSON object request body.
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15
idstringyesinstance id of buildings
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Returns one building by its ID, with its street address. Find the ID with jamf_list_buildings.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of building record

[Jamf Pro] Lists the buildings defined in Jamf Pro. A building is one of the two location fields, with departments, that policies, configuration profiles and smart groups can be scoped by. Use jamf_list_departments for the other one. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter buildings collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: name, streetAddress1, streetAddress2, city, stateProvince, zipPostalCode, country. This param can be combined with paging and sorting. Example: filter=city=="Chicago" and name=="build"
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Returns the change history of one building: who changed it, when, and the notes recorded against it. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15
idstringyesinstance id of building history record
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Replaces a building by its ID. This is a whole-record replacement: address fields you leave out of the body are cleared. Devices and users already assigned to the building keep the assignment. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of building record

Buildings (Classic API)

ToolPlanAccessSummary
jamf_classic_create_buildings_idProWriteCreates a building.
jamf_classic_delete_buildings_idProDestructiveDeletes one building by its numeric ID.
jamf_classic_delete_buildings_nameProDestructiveDeletes one building by its exact name.
jamf_classic_get_buildings_idFreeRead-onlyReturns one building by its numeric ID.
jamf_classic_get_buildings_nameFreeRead-onlyReturns one building by its exact name.
jamf_classic_list_buildingsFreeRead-onlyLists the buildings defined in Jamf Pro.
jamf_classic_update_buildings_idProDestructiveReplaces a building by its numeric ID.
jamf_classic_update_buildings_nameProDestructiveReplaces a building by its exact name.

[Jamf Pro] Creates a building. Send 0 as the ID to let Jamf Pro assign the next free one. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes one building by its numeric ID. Every device and user assigned to it loses that location value, and smart groups and policies scoped by the building stop matching them. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes one building by its exact name. Every device and user assigned to it loses that location value, and smart groups and policies scoped by the building stop matching them. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Returns one building by its numeric ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Returns one building by its exact name. Use jamf_classic_get_buildings_id when you already have the numeric ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Lists the buildings defined in Jamf Pro. On a large server prefer jamf_list_buildings, which pages, sorts and filters; this call returns the whole collection. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Replaces a building by its numeric ID. Fields absent from the document are cleared. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Replaces a building by its exact name. Fields absent from the document are cleared. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName to filter by

Categories

ToolPlanAccessSummary
jamf_create_categoriesProWriteCreates a category.
jamf_create_categories_historyProWriteAdds a note to a category's change history.
jamf_delete_categoriesProDestructiveDeletes one category by its ID.
jamf_delete_multiple_categoriesProDestructiveDeletes several categories at once, by ID.
jamf_get_categoriesFreeRead-onlyReturns one category by its ID, with its display priority.
jamf_list_categoriesFreeRead-onlyLists the categories defined in Jamf Pro.
jamf_list_categories_historyFreeRead-onlyReturns the change history of one category: who changed it, when, and the notes recorded against it.
jamf_update_categoriesProDestructiveReplaces a category by its ID.

[Jamf Pro] Creates a category. This adds a grouping value; moving items into it is a separate write on each item. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Adds a note to a category's change history. This records text against the category and changes no field on it. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of category history record

[Jamf Pro] Deletes one category by its ID. Every policy, package, script and Self Service item filed under it falls back to no category, and Self Service stops offering that browse heading. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of category record

[Jamf Pro] Deletes several categories at once, by ID. Every item filed under any of them falls back to no category, and Self Service stops offering those browse headings. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Returns one category by its ID, with its display priority. Find the ID with jamf_list_categories.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of category record

[Jamf Pro] Lists the categories defined in Jamf Pro. A category groups policies, packages, scripts, printers and Self Service items, and it is the heading users browse by in Self Service. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter categories collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: name, priority. This param can be combined with paging and sorting. Example: filter=name=="Apps*" and priority>=5
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Returns the change history of one category: who changed it, when, and the notes recorded against it. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15
idstringyesinstance id of category history record
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Replaces a category by its ID. This is a whole-record replacement: the name and the display priority you leave out of the body are cleared. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of category record

Categories (Classic API)

ToolPlanAccessSummary
jamf_classic_create_categories_idProWriteCreates a category.
jamf_classic_delete_categories_idProDestructiveDeletes one category by its numeric ID.
jamf_classic_delete_categories_nameProDestructiveDeletes one category by its exact name.
jamf_classic_get_categories_idFreeRead-onlyReturns one category by its numeric ID, with its display priority.
jamf_classic_get_categories_nameFreeRead-onlyReturns one category by its exact name.
jamf_classic_list_categoriesFreeRead-onlyLists the categories defined in Jamf Pro.
jamf_classic_update_categories_idProDestructiveReplaces a category by its numeric ID.
jamf_classic_update_categories_nameProDestructiveReplaces a category by its exact name.

[Jamf Pro] Creates a category. Send 0 as the ID to let Jamf Pro assign the next free one. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes one category by its numeric ID. Every policy, package, script and Self Service item filed under it falls back to no category. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes one category by its exact name. Every policy, package, script and Self Service item filed under it falls back to no category. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Returns one category by its numeric ID, with its display priority. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Returns one category by its exact name. Use jamf_classic_get_categories_id when you already have the numeric ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Lists the categories defined in Jamf Pro. On a large server prefer jamf_list_categories, which pages, sorts and filters; this call returns the whole collection. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Replaces a category by its numeric ID. Fields absent from the document are cleared. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Replaces a category by its exact name. Fields absent from the document are cleared. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName to filter by

Classes (Classic API)

ToolPlanAccessSummary
jamf_classic_create_classes_idProWriteCreates an Apple Classroom class.
jamf_classic_delete_classes_idProDestructiveDeletes a class by its numeric ID.
jamf_classic_delete_classes_nameProDestructiveDeletes a class by its exact name.
jamf_classic_get_classes_idFreeRead-onlyReturns one class by its numeric ID, with its teachers, its students and the devices in it.
jamf_classic_get_classes_nameFreeRead-onlyReturns one class by its exact name.
jamf_classic_list_classesFreeRead-onlyLists the classes defined in Jamf Pro.
jamf_classic_update_classes_idProDestructiveReplaces a class by its numeric ID.
jamf_classic_update_classes_nameProDestructiveReplaces a class by its exact name.

[Jamf Pro] Creates an Apple Classroom class. Send 0 as the ID to let Jamf Pro assign the next free one. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Deletes a class by its numeric ID. Its teachers lose Apple Classroom control of the student devices that were in it. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Deletes a class by its exact name. Its teachers lose Apple Classroom control of the student devices that were in it. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
namestringyesName value to filter by

[Jamf Pro] Returns one class by its numeric ID, with its teachers, its students and the devices in it. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
idstringyesID value to filter by

[Jamf Pro] Returns one class by its exact name. Use jamf_classic_get_classes_id when you already have the numeric ID. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

ParamTypeRequiredDefaultDescription
namestringyesName to filter by

[Jamf Pro] Lists the classes defined in Jamf Pro. A class is an Apple Classroom class: the teachers, the students and the iPads they use together. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads.

[Jamf Pro] Replaces a class by its numeric ID. Teachers, students and devices absent from the document are removed from the class. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
idstringyesID value to filter by

[Jamf Pro] Replaces a class by its exact name. Teachers, students and devices absent from the document are removed from the class. Served by the Jamf Classic API (/JSSResource); StackJack requests JSON on reads. Supply the Jamf Classic API XML document in bodyXml, shaped as the Classic API documents for this resource. Leave it empty when the endpoint takes no body. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
bodyXmlstringnonullJamf Classic API XML request body.
namestringyesName value to filter by

Current User

ToolPlanAccessSummary
jamf_create_user_change_passwordProDestructiveChanges the Jamf Pro password of the account the request authenticates as, and needs the current password as well as the new one.
jamf_create_user_updatesessionProWriteUpdates values in the session this connection is using, such as the site it is scoped to.
jamf_delete_user_preferencesProDestructiveRemoves one saved interface preference of the account this connection authenticates as.
jamf_get_user_preferencesFreeRead-onlyReturns one saved interface preference of the account this connection authenticates as, by its key.
jamf_get_user_preferences_settingsFreeRead-onlyReturns the settings behind one saved interface preference of the account this connection authenticates as, by its key.
jamf_list_userFreeRead-onlyReturns the Jamf Pro administrator accounts defined on the server.
jamf_update_user_preferencesProDestructiveReplaces one saved interface preference of the account this connection authenticates as.

[Jamf Pro] Changes the Jamf Pro password of the account the request authenticates as, and needs the current password as well as the new one. The old password stops working at once, and any saved credential still holding it fails on its next call. A connection that authenticates with an API client has no password for this to change. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Updates values in the session this connection is using, such as the site it is scoped to. It affects this connection only and edits no stored account. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Removes one saved interface preference of the account this connection authenticates as. The account falls back to the default for that key. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
keyIdstringyesunique key of user setting to be persisted
ParamTypeRequiredDefaultDescription
keyIdstringyesuser setting to be retrieved
ParamTypeRequiredDefaultDescription
keyIdstringyesuser setting to be retrieved

[Jamf Pro] Returns the Jamf Pro administrator accounts defined on the server. These are the people who sign in to Jamf Pro; jamf_list_users returns the inventory users that devices are assigned to.

[Jamf Pro] Replaces one saved interface preference of the account this connection authenticates as. The previous value for that key is overwritten, not merged. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
keyIdstringyesunique key of user setting to be persisted

Departments

ToolPlanAccessSummary
jamf_create_departmentsProWriteCreates a department.
jamf_create_departments_historyProWriteAdds a note to a department's change history.
jamf_delete_departmentsProDestructiveDeletes one department by its ID.
jamf_delete_multiple_departmentsProDestructiveDeletes several departments at once, by ID.
jamf_get_departmentsFreeRead-onlyReturns one department by its ID.
jamf_list_departmentsFreeRead-onlyLists the departments defined in Jamf Pro.
jamf_list_departments_historyFreeRead-onlyReturns the change history of one department: who changed it, when, and the notes recorded against it.
jamf_update_departmentsProDestructiveReplaces a department by its ID.

[Jamf Pro] Creates a department. This adds a location value; assigning devices or users to it is a separate write on each record. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Adds a note to a department's change history. This records text against the department and changes no field on it. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.
idstringyesinstance id of department history record

[Jamf Pro] Deletes one department by its ID. Every device and user assigned to it loses that location value, and smart groups and policies scoped by the department stop matching them. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of department record

[Jamf Pro] Deletes several departments at once, by ID. Every device and user assigned to any of them loses that location value, and smart groups and policies scoped by those departments stop matching them. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API documents for this endpoint. DESTRUCTIVE: this changes or removes Jamf Pro configuration, or acts on a managed device. Confirm the target before running it.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object request body.

[Jamf Pro] Returns one department by its ID. Find the ID with jamf_list_departments.

ParamTypeRequiredDefaultDescription
idstringyesinstance id of department record

[Jamf Pro] Lists the departments defined in Jamf Pro. A department is one of the two location fields, with buildings, that policies, configuration profiles and smart groups can be scoped by. Use jamf_list_buildings for the other one. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter department collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: id, name. Example: name=="department"
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is id:asc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Returns the change history of one department: who changed it, when, and the notes recorded against it. Paginated: page is zero-based and pageSize is capped at 200 by StackJack. filter takes an RSQL expression, for example general.name=="MacBook*".

ParamTypeRequiredDefaultDescription
filterstringnonullQuery in the RSQL format, allowing to filter history notes collection. Default filter is empty query - returning all results for the requested page. Fields allowed in the query: username, date, note, details. This param can be combined with paging and sorting. Example: filter=username!=admin and details==disabled and date<2019-12-15
idstringyesinstance id of department history record
pageintegerno0Zero-based page number.
pageSizeintegerno100Records per page. StackJack caps this at 200, which is its own safety limit rather than a Jamf one.
sortstringnonullSorting criteria in the format: property:asc/desc. Default sort is date:desc. Multiple sort criteria are supported and must be separated with a comma. Example: sort=date:desc,name:asc

[Jamf Pro] Replaces a department by its ID. This is a whole-record replacement: fields you leave out of the body are cleared. Devices and users already assigned to the department keep the assignment. Supply the request body as a JSON object in fieldsJson, shaped as the Jamf Pro API docum

Still need help? Ask the team