Jump to Content
Log In
Home
Guides
Recipes
API Reference
Changelog
v10.29.0
v10.30.0
v10.31.0
v10.32.0
v10.33.0
v10.34.0
v10.35.0
v10.36.0
v10.37.0
v10.38.0
v10.39.0
v10.40.0
v10.41.0
v10.42.0
v10.43.0
v10.44.0
v10.45.0
v10.46.0
v10.47.0
v10.48.0
v10.49.0
v10.50.0
v11.0.0
v11.1.0
v11.2.0
v11.3.0
v11.4.0
v11.5.0
v11.6.0
v11.7.0
v11.9.0
v11.10.0
v11.11.0
v11.12.0
v11.13.0
v11.14.0
v11.15.0
v11.16.0
Log In
API Reference
v11.16.0
Home
Guides
Recipes
API Reference
Changelog
Search for Departments
Search
JUMP TO
Classic API Introduction
Getting Started
Classic API
accounts
Finds all accounts
get
Finds groups by ID
get
Updates an existing group by ID
put
Creates a new group by ID
post
Deletes a group by ID
delete
Finds groups by name
get
Updates an existing group by name
put
Deletes a group by name
delete
Finds accounts by ID
get
Updates an existing account by ID
put
Creates a new account by ID
post
Deletes an account by ID
delete
Finds accounts by name
get
Updates an existing account by name
put
Deletes an account by name
delete
activationcode
Finds the Jamf Pro activation code
get
Updates the Jamf Pro activation code
put
advancedcomputersearches
Finds all advanced computer searches
get
Finds computer searches by ID
get
Updates an existing advanced computer search by ID
put
Creates a new advanced computer search
post
Deletes a computer search by ID
delete
Finds advanced computer searches by name
get
Updates an existing advanced computer search by name
put
Deletes a computer search by name
delete
advancedmobiledevicesearches
Finds all advanced mobile device searches
get
Finds mobile device searches by ID
get
Updates an existing advanced mobile device search by ID
put
Creates a new advanced mobile device search
post
Deletes a mobile device search by ID
delete
Finds advanced mobile device searches by name
get
Updates an existing advanced mobile device search by name
put
Deletes a mobile device search by name
delete
advancedusersearches
Finds all advanced user searches
get
Finds user searches by ID
get
Updates an existing advanced user search by ID
put
Creates a new advanced user search by ID
post
Deletes a user search by ID
delete
Finds user searches by name
get
Updates an existing advanced user search by name
put
Deletes a user search by Name
delete
allowedfileextensions
Finds the allowed file extensions
get
Finds an allowed file extension value by ID
get
Creates a new allowed file extension value by ID
post
Deletes an allowed file extension value by ID
delete
Finds an allowed file extension value by name
get
buildings
Finds all buildings
get
Finds buildings by ID
get
Updates an existing building by ID
put
Creates a new building
post
Deletes a building by ID
delete
Finds buildings by name
get
Updates an existing building by name
put
Deletes a building by name
delete
byoprofiles
Finds all personal device profiles
get
Finds personal device profile by ID
get
Updates a personal device profile by ID
put
Creates a personal device profile by ID
post
Deletes a personal device profile by ID
delete
Finds a personal device profile by name
get
Updates a personal device profile by name
put
Deletes a personal device profile by name
delete
categories
Finds all categories
get
Finds categories by ID
get
Updates an existing category by ID
put
Creates a new category by ID
post
Deletes a category by ID
delete
Finds categories by name
get
Updates an existing category by name
put
Deletes a category by name
delete
classes
Finds all classes
get
Finds classes by ID
get
Updates an existing class by ID
put
Creates a new class by ID
post
Deletes a class by ID
delete
Finds classes by name
get
Updates an existing class by name
put
Deletes a class by name
delete
commandflush
Flushes commands based on information specified in an XML file
delete
Flushes commands for devices
delete
computerapplications
Finds computer applications by name
get
Finds computer applications by name with additional display fields
get
Finds computer applications by name and version
get
Finds computer applications by name and version
get
computerapplicationusage
Finds computer application usage by computer ID
get
Finds computer application usage by computer name
get
Finds computer application usage by computer UDID
get
Finds computer application usage by computer serial number
get
Finds computer application usage by computer MAC address
get
computercheckin
Finds the Jamf Pro computer checkin information
get
Updates the Jamf Pro computer checkin information
put
computercommands
Finds all computer commands
get
Finds all computer commands by name
get
Finds a computer command by UUID
get
Creates a new computer command using command name
post
Creates a new computer command using command name and device IDs
post
Creates a new computer command with a command specific action. Commands supported: ScheduleOSUpdate (deprecated on 2022-10-17)
post
Creates a new computer command using command name and device IDs
post
computerextensionattributes
Finds all computer extension attributes
get
Finds computer extension attributes by ID
get
Updates an existing computer extension attribute by ID
put
Creates a new computer extension attribute by ID
post
Deletes a computer extension attribute by ID
delete
Finds computer extension attributes by name
get
Updates an existing computer extension attribute by name
put
Deletes a computer extension attribute by name
delete
computergroups
Finds all computer groups
get
Finds computer groups by ID
get
Updates an existing computer group by ID
put
Creates a new computer group by ID
post
Deletes a computer group by ID
delete
Finds computer groups by name
get
Updates an existing computer group by name
put
Deletes a computer group by name
delete
computerhardwaresoftwarereports
Finds hardware/software reports by computer ID
get
Finds a subset of hardware/software reports by computer ID
get
Finds hardware/software reports by computer name
get
Finds a subset of hardware/software reports by computer name
get
Finds hardware/software reports by computer UDID
get
Finds a subset of hardware/software reports by computer UDID
get
Finds hardware/software reports by computer serial number
get
Finds a subset of hardware/software reports by computer serial number
get
Finds hardware/software reports by computer MAC address
get
Finds a subset of hardware/software reports by computer MAC address
get
computerhistory
Finds computer history by ID
get
Finds a subset of computer history data by ID
get
Finds computer history by name
get
Finds a subset of computer history data by name
get
Finds computer history by UDID
get
Finds a subset of computer history data by UDID
get
Finds computer history by serial number
get
Finds a subset of computer history data by serial number
get
Finds computer history by MAC address
get
Finds a subset of computer history data by MAC address
get
computerinventorycollection
Finds the Jamf Pro computer inventory collection information
get
Updates the Jamf Pro computer inventory collection information
put
computerinvitations
Finds all computer invitations
get
Finds computer invitations by id
get
Creates a new computer invitation by id
post
Deletes a computer invitation by id
delete
Finds computer invitations by invitation
get
Creates a new computer invitation by invitation
post
Deletes a computer invitation by invitation
delete
computermanagement
Finds computer management information by ID
get
Finds a subset of computer management information by ID
get
Finds management information for a computer and username
get
Finds a subset of management information for a computer and username
get
Display patch management information for a computer and filter
get
Finds computer management information by name
get
Finds a subset of computer management information by name
get
Finds management information for a computer and username
get
Finds a subset of management information for a computer and username
get
Display patch management information for a computer and filter
get
Finds computer management information by UDID
get
Finds a subset of computer management information by UDID
get
Finds management information for a computer and username
get
Finds a subset of management information for a computer and username
get
Display patch management information for a computer and filter
get
Finds computer management information by serial number
get
Finds a subset of computer management information by serial number
get
Finds management information for a computer and username
get
Finds a subset of management information for a computer and username
get
Display patch management information for a computer and filter
get
Finds computer management information by MAC address
get
Finds a subset of computer management information by MAC address
get
Finds management information for a computer and username
get
Finds a subset of management information for a computer and username
get
Display patch management information for a computer and filter
get
computerreports
Finds all computer reports
get
Finds computer reports by id
get
Finds computer reports by name
get
computers
Finds all computers
get
Finds basic information for all computers
get
Searches for computers that match the provided parameter
get
Searches for computers that match the provided name parameter
get
Finds computers by ID
get
Updates an existing computer by ID
put
Creates a computer
post
Deletes a computer by ID
delete
Finds a subset of information for a computer
get
Finds the first computer with the given name
get
Updates an existing computer by name
put
Deletes a computer by name
delete
Finds a subset of data for the first computer with the given name
get
Finds computers by UDID
get
Updates an existing computer by UDID
put
Deletes a computer by UDID
delete
Finds a subset of data for computers by UDID
get
Finds computers by serial number
get
Updates an existing computer by serial number
put
Deletes a computer by serial number
delete
Finds a subset of data for computers by serial number
get
Finds computers by MAC address
get
Updates an existing computer by MAC address
put
Deletes a computer by MAC address
delete
Finds a subset of data for computers by MAC address
get
departments
Finds all departments
get
Finds departments by ID
get
Updates an existing department by ID
put
Creates a new department by ID
post
Deletes a department by ID
delete
Finds departments by name
get
Updates an existing department by name
put
Deletes a department by name
delete
directorybindings
Finds all directory bindings
get
Finds directory bindings by ID
get
Updates an existing directory binding by ID
put
Creates a new directory binding by ID
post
Deletes a directory binding by ID
delete
Finds directory bindings by name
get
Updates an existing directory binding by name
put
Deletes a directory binding by name
delete
diskencryptionconfigurations
Finds all disk encryption configurations
get
Finds disk encryption configurations by ID
get
Updates an existing disk encryption configuration by ID
put
Creates a new disk encryption configuration by ID
post
Deletes a disk encryption configuration by ID
delete
Finds disk encryption configurations by name
get
Updates an existing disk encryption configuration by name
put
Deletes a disk encryption configuration by name
delete
distributionpoints
Finds all distribution points
get
Finds distribution points by ID
get
Updates an existing distribution point by ID
put
Creates a new distribution point by ID
post
Deletes a distribution point by ID
delete
Finds distribution points by name
get
Updates an existing distribution point by name
put
Deletes a distribution point by name
delete
dockitems
Finds all dock items
get
Finds dock items by ID
get
Updates an existing dock item by ID
put
Creates a new dock item by ID
post
Deletes a dock item by ID
delete
Finds dock items by name
get
Updates an existing dock item by name
put
Deletes a dock item by name
delete
ebooks
Finds all ebooks
get
Finds ebooks by ID
get
Updates an existing ebook by ID
put
Creates a new ebook by ID
post
Deletes an ebook by ID
delete
Finds a subset of data for an ebook by ID
get
Finds ebooks by name
get
Updates an existing ebook by name
put
Deletes an ebook by name
delete
Finds a subset of data for ebooks by name
get
fileuploads
Creates file attachments in Jamf Pro
post
gsxconnection
Finds the Jamf Pro GSX connection information
get
Updates the Jamf Pro GSX connection information
put
healthcarelistener
Find all Healthcare Listeners
get
Finds healthcare listener by ID
get
Updates an existing healthcare listener by ID
put
healthcarelistenerrule
Find all Healthcare Listener rules
get
Finds Healthcare Listener rules by ID
get
Updates an existing Healthcare Listener rule by ID
put
Creates a new Healthcare Listener rule
post
ibeacons
Finds all iBeacon regions
get
Finds iBeacon regions by ID
get
Updates an existing iBeacon region by ID
put
Creates a new iBeacon region by ID
post
Deletes an iBeacon region by ID
delete
Finds iBeacon regions by name
get
Updates an existing iBeacon region by name
put
Deletes an iBeacon region by name
delete
infrastructuremanager
Find all Infrastructure Managers
get
Finds infrastructure manager by ID
get
Updates an existing infrastructure manager by ID
put
jssuser
Returns basic information about Jamf Pro, as well as privileges of the person requesting the resource. (Deprecated)
get
jsonwebtokenconfigurations
Finds all JSON Web Token configurations
get
Find JSON Web Token configuration by ID
get
Updates an existing JSON Web Token configuration by ID
put
Creates a new JSON Web Token configuration by ID
post
Deletes a JSON Web Token configuration by ID
delete
ldapservers
Finds all LDAP servers
get
Finds LDAP servers by ID
get
Updates an existing LDAP server by ID
put
Creates a new LDAP server by ID
post
Deletes an LDAP server by ID
delete
Display information for matching users for an LDAP server
get
Display information for matching groups for an LDAP server
get
Display information about user membership in a group for an LDAP server
get
Finds LDAP servers by name
get
Updates an existing LDAP server by name
put
Deletes an LDAP server by name
delete
Display information for matching users for an LDAP server
get
Display information for matching groups for an LDAP server
get
Display information about user membership in a group for an LDAP server
get
licensedsoftware
Finds all licensed software
get
Finds licensed software by ID
get
Updates existing licensed software by ID
put
Creates new licensed software by ID
post
Deletes licensed software by ID
delete
Finds licensed software by name
get
Updates an existing licensed software by name
put
Deletes licensed software by name
delete
logflush
Flushes a log specified in an XML file
delete
Flushes all logs for a given interval
delete
Flushes a single log for a given interval
delete
macapplications
Finds all mac applications
get
Finds mac applications by ID
get
Updates an existing mac application by ID
put
Creates a new mac application by ID
post
Deletes a mac application by ID
delete
Finds a subset of date for a mac application by ID
get
Finds mac applications by name
get
Updates an existing mac application by name
put
Deletes a mac application by name
delete
Finds a subset of data for mac applications by name
get
mobiledeviceapplications
Finds all mobile device applications
get
Finds mobile device applications by ID
get
Updates an existing mobile device application by ID
put
Creates a new mobile device application by ID
post
Deletes a mobile device application by ID
delete
Finds mobile device applications by bundle ID
get
Updates an existing mobile device application by bundle ID
put
Deletes a mobile device application by bundle ID
delete
Finds mobile device applications by bundle ID and version
get
Updates an existing mobile device application by bundle ID and version
put
Deletes a mobile device application by bundle ID and version
delete
Finds a subset of data for a mobile device application by ID
get
Finds mobile device applications by name
get
Updates an existing mobile device application by name
put
Deletes a mobile device application by name
delete
Finds a subset of data for mobile device applications by name
get
mobiledevicecommands
Finds all mobile device commands
get
Finds a mobile device command by UUID
get
Finds all mobile device commands by command name
get
Finds all mobile device commands for specified command
get
Creates a new mobile device command
post
Creates a new mobile device command
post
Creates a new command to set the name of a mobile device. (DeviceName Deprecated on 2024-06-27)
post
Sends a new lock command to a list of mobile devices
post
Creates a new command to request that a mobile device update its OS. Command and mobile device list specified in URL. Device will be updated to the latest OS version based on device eligibility. (deprecated on 2022-10-17)
post
Creates a new command to request that a mobile device update its OS. Command and mobile device list specified in URL. Mixing iOS and tvOS devices in ID list is not advised, as product version is specific to OS type. (deprecated on 2022-10-17)
post
mobiledeviceconfigurationprofiles
Finds all mobile device configuration profiles
get
Finds mobile device configuration profiles by ID
get
Updates an existing mobile device configuration profile by ID
put
Creates a new mobile device configuration profile by ID
post
Deletes a mobile device configuration profile by ID
delete
Finds a subset of data for a mobile device configuration profile by ID
get
Finds mobile device configuration profiles by name
get
Updates an existing mobile device configuration profile by name
put
Deletes a mobile device configuration profile by name
delete
Finds a subset of data for mobile device configuration profiles by name
get
mobiledeviceenrollmentprofiles
Finds all mobile device enrollment profiles
get
Finds mobile device enrollment profiles by ID
get
Updates an existing mobile device enrollment profile by ID
put
Creates a new mobile device enrollment profile by ID
post
Deletes a mobile device enrollment profile by ID
delete
Finds mobile device enrollment profiles by invitation
get
Updates an existing mobile device enrollment profile by invitation
put
Deletes a mobile device enrollment profile by invitation
delete
Finds a subset of data for an enrollment profile
get
Finds mobile device enrollment profiles by name
get
Updates an existing mobile device enrollment profile by name
put
Deletes a mobile device enrollment profile by name
delete
Finds a subset of data for mobile device enrollment profiles by name
get
mobiledeviceextensionattributes
Finds all mobile device extension attributes
get
Finds mobile device extension attributes by ID
get
Updates an existing mobile device extension attribute by ID
put
Creates a new mobile device extension attribute by ID
post
Deletes a mobile device extension attribute by ID
delete
Finds mobiledeviceextensionattributes by name
get
Updates an existing mobile device extension attribute by name
put
Deletes a mobile device extension attribute by name
delete
mobiledevicegroups
Finds all mobile device groups
get
Finds mobile device groups by ID
get
Updates an existing mobile device group by ID
put
Creates a new mobile device group by ID
post
Deletes a mobile device group by ID
delete
Finds mobile device groups by name
get
Updates an existing mobile device group by name
put
Deletes a mobile device group by name
delete
mobiledevicehistory
Finds mobile device history by ID
get
finds a subset of data for a mobile device history
get
Finds mobile device history by name
get
Finds a subset of data for mobile device history by name
get
Finds mobile device history by UDID
get
Finds a subset of data for mobile device history by UDID
get
Finds mobile device history by serial number
get
Finds a subset of data for mobile device history by serial number
get
Finds mobile device history by wifi mac address
get
Finds a subset of data for mobile device history by wifi mac address
get
mobiledeviceinvitations
Finds all mobile device invitations
get
Finds mobile device invitations by id
get
Creates a new mobile device invitation by id
post
Deletes a mobile device invitation by id
delete
Finds mobile device invitations by invitation
get
Creates a new mobile device invitation by invitation
post
Deletes a mobile device invitation by invitation
delete
mobiledeviceprovisioningprofiles
Finds all mobile device provisioning profiles
get
Finds a mobile device provisioning profiles by id
get
Updates an existing mobile device provisioning profiles by id
put
Creates a mobile device provisioning profiles by id
post
Deletes a mobile device provisioning profiles by id
delete
Finds a mobile device provisioning profiles by name
get
Updates an existing mobile device provisioning profiles by name
put
Creates a mobile device provisioning profiles by name
post
Deletes a mobile device provisioning profiles by name
delete
Finds a mobile device provisioning profiles by uuid
get
Updates an existing mobile device provisioning profiles by uuid
put
Creates a mobile device provisioning profiles by uuid
post
Deletes a mobile device provisioning profiles by uuid
delete
mobiledevices
Finds all mobile devices
get
Searches for mobile devices that match the provided parameter
get
Finds mobile devices by ID
get
Updates an existing mobile device by ID
put
Creates a new mobile device by ID
post
Deletes a mobile device by ID
delete
Finds a subset of data for a mobile device
get
Finds mobile devices by name
get
Updates an existing mobile device by name
put
Deletes a mobile device by name
delete
Finds a subset of data for mobile devices by name
get
Finds mobile devices by UDID
get
Updates an existing mobile device by UDID
put
Deletes a mobile device by UDID
delete
Finds a subset of data for mobile devices by UDID
get
Finds mobile devices by serial number
get
Updates an existing mobile device by serial number
put
Deletes a mobile device by serial number
delete
Finds a subset of data for mobile devices by serial number
get
Finds mobile devices by Mac address
get
Updates an existing mobile device by Mac address
put
Deletes a mobile device by Mac address
delete
Finds a subset of data for mobile devices by Mac address
get
networksegments
Finds all network segments
get
Finds network segments by ID
get
Updates an existing network segment by ID
put
Creates a new network segment by ID
post
Deletes a network segment by ID
delete
Finds network segments by name
get
Updates an existing network segment by name
put
Deletes a network segment by name
delete
osxconfigurationprofiles
Finds all OS X configuration profiles
get
Finds OS X configuration profiles by ID
get
Updates an existing OS X configuration profile by ID
put
Creates a new OS X configuration profile by ID
post
Deletes a OS X configuration profile by ID
delete
Finds a subset of data for an OS X configuration profile
get
Finds OS X configuration profiles by name
get
Updates an existing OS X configuration profile by name
put
Deletes a OS X configuration profile by name
delete
Finds a subset of data for OS X configuration profiles by name
get
packages
Finds all packages
get
Finds packages by ID
get
Updates an existing package by ID
put
Creates a new package by ID
post
Deletes a package by ID
delete
Finds packages by name
get
Updates an existing package by name
put
Deletes a package by name
delete
patchavailabletitles
Finds all available title from a source by ID
get
patches
Finds all patches (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".
get
Finds patches by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".)
get
Updates a Patch Software Title by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".)
put
Creates a patch software title (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".)
post
Deletes a Patch Software Title by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".)
delete
Display computers on a specific version (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}/definitions".)
get
Finds the first patch with the name provided (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".)
get
Updates a Patch Software Title by name (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".)
put
Deletes a Patch Software Title by name (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".)
delete
Display computers on a specific version (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".)
get
patchexternalsources
Finds all patch external sources
get
Finds a patch external source by ID
get
Updates a patch external source by ID
put
Create a new patch external source by ID
post
Deletes a patch external source by ID
delete
Finds the first patch external source with the name provided
get
Updates a patch external source by name
put
Create a new patch external source by name
post
patchinternalsources
Finds all patch internal sources
get
Finds a patch internal source by ID
get
Finds the first patch internal source with the name provided
get
patchpolicies
Finds all patch policies. (Deprecated). Please transition use to Jamf Pro API endpoint "/v2/patch-policies".
get
Finds a patch policy by ID
get
Updates an existing patch policy by ID
put
Deletes a patch policy by ID
delete
Display subsets of information for a patch policy
get
Finds all patch policies by patch software title configuration ID (Deprecated). Please transition use to Jamf Pro API endpoint "/v2/patch-policies".
get
Create a new patch policy associated with a patch software title configuration ID
post
patchreports
Finds patch reports by patch software title ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}/patch-report".
get
Display computers for a specific version of a patch report. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}/patch-report".
get
patchsoftwaretitles
Finds all patch software titles. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".
get
Finds a patch software titles by ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".
get
Updates a patch software title by ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".
put
Creates new patch software title by ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".
post
Deletes a patch software title by ID. (Deprecated) Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".
delete
peripherals
Finds all peripherals
get
Finds peripherals by ID
get
Updates an existing peripheral by ID
put
Creates a new peripheral by ID
post
Deletes a peripheral by ID
delete
Finds a subset of data for a peripheral
get
peripheraltypes
Finds all peripheral types
get
Finds peripheral types by ID
get
Updates an existing peripheral by ID
put
Creates a new peripheral by ID
post
Deletes a peripheral by ID
delete
policies
Finds all policies
get
Finds policies by ID
get
Updates an existing policy by ID
put
Creates a new policy by ID
post
Deletes a policy by ID
delete
Finds a subset of data for a policy
get
Finds policies by name
get
Updates an existing policy by name
put
Deletes a policy by name
delete
Finds a subset of data for policies by name
get
Finds all policies by category
get
Finds all policies by type
get
printers
Finds all printers
get
Finds printers by ID
get
Updates an existing printer by ID
put
Creates a new printer by ID
post
Deletes a printer by ID
delete
Finds printers by name
get
Updates an existing printer by name
put
Deletes a printer by name
delete
removablemacaddresses
Finds all removable Mac addresses
get
Finds removable Mac addresses by ID
get
Updates an existing removable Mac address by ID
put
Creates a new removable Mac address by ID
post
Deletes a removable Mac address by ID
delete
Finds removable Mac addresses by name
get
Updates an existing removable Mac address by name
put
Deletes a removable Mac address by name
delete
restrictedsoftware
Finds all restricted software
get
Finds restricted software by ID
get
Updates an existing restricted software by ID
put
Creates a new restricted software by ID
post
Deletes a restricted software by ID
delete
Finds restricted software by name
get
Updates an existing restricted software by name
put
Deletes a restricted software by name
delete
savedsearches
Finds all saved searches (Deprecated - use advancedcomputersearches, advancedmobiledevicesearches and advancedusersearches)
get
Finds saved searches by ID (Deprecated - use advancedcomputersearches, advancedmobiledevicesearches and advancedusersearches)
get
Finds saved searches by name (Deprecated - use advancedcomputersearches, advancedmobiledevicesearches and advancedusersearches)
get
scripts
Finds all scripts
get
Finds scripts by ID
get
Updates an existing script by ID
put
Creates a new script by ID
post
Deletes a script by ID
delete
Finds scripts by name
get
Updates an existing script by name
put
Deletes a script by name
delete
sites
Finds all sites
get
Finds sites by ID
get
Updates an existing site by ID
put
Creates a new site by ID
post
Deletes a site by ID
delete
Finds sites by name
get
Updates an existing site by name
put
Deletes a site by name
delete
smtpserver
Finds the Jamf Pro SMTP server information
get
Updates the Jamf Pro SMTP server information
put
softwareupdateservers
Finds all software update servers
get
Finds software update servers by ID
get
Updates an existing software update server by ID
put
Creates a new software update server by ID
post
Deletes a software update server by ID
delete
Finds software update servers by name
get
Updates an existing software update server by name
put
Deletes a software update server by name
delete
userextensionattributes
Finds all user extension attributes
get
Finds user extension attributes by ID
get
Updates an existing user extension attribute by ID
put
Creates a new user extension attribute by ID
post
Deletes a user extension attribute by ID
delete
Finds user extension attributes by name
get
Updates an existing user extension attribute by name
put
Deletes a user extension attribute by name
delete
usergroups
Finds all user groups
get
Finds user groups by ID
get
Updates user groups by ID
put
Creates user groups by ID
post
Deletes user groups by ID
delete
Finds user groups by name
get
Updates user groups by name
put
Deletes user groups by name
delete
users
Finds all users
get
Finds users by ID
get
Updates an existing user by ID
put
Creates a new user by ID
post
Deletes a user by ID
delete
Finds users by name
get
Updates an existing user by name
put
Deletes a user by name
delete
Finds users by email address
get
Updates an existing user by email address
put
Deletes a user by email address
delete
vppaccounts
Finds all VPP Accounts
get
Finds VPP Account by ID
get
Updates a VPP account by ID
put
Creates a new VPP account by ID
post
Deletes a VPP account by ID
delete
vppassignments
Finds all VPP Assignments
get
Finds VPP Assignment by ID
get
Updates a VPP assignment by ID
put
Creates a new VPP assignment by ID
post
Deletes a VPP assignment by ID
delete
vppinvitations
Finds all VPP Invitations
get
Finds a VPP Invitation by ID
get
Updates a VPP invitation by ID
put
Creates a new VPP invitation by ID
post
Deletes a VPP invitation by ID
delete
Finds a subset of data for a VPP invitation
get
webhooks
Finds all webhooks
get
Finds webhooks by ID
get
Updates an existing webhook by ID
put
Creates a new webhook by ID
post
Deletes a webhook by ID
delete
Finds webhooks by name
get
Updates an existing webhook by name
put
Deletes a webhook by name
delete
Jamf Pro API Introduction
Getting Started
Jamf Pro API
accounts
Adds new account.
post
Gets the user account.
get
activation-code
Updates Activation Code
put
adcs-settings
Create AD CS Settings configuration for either inbound or outbound mode
post
Validate AD CS Settings server certificate
post
Validate AD CS Settings client certificate
post
Get AD CS Settings configuration for the ID value
get
Delete AD CS Settings configuration by ID
delete
Update AD CS Settings configuration
patch
Retrieve list of AD CS Settings dependencies
get
Get specified AD CS Settings history object
get
Add specified AD CS Settings object note
post
advanced-mobile-device-searches
Get Advanced Search objects
get
Create Advanced Search object
post
Get Mobile Device Advanced Search criteria choices
get
Remove specified Advanced Search objects
post
Get specified Advanced Search object
get
Get specified Advanced Search object
put
Remove specified Advanced Search object
delete
advanced-user-content-searches
Get All Advanced User Content Search objects
get
Create Advanced User Content Search object
post
Get Specified Advanced User Content Search object
get
Get Specified Advanced User Content Search object
put
Remove specified Advanced User Content Search object
delete
api-authentication
Get all the Authorization details associated with the current api
get
Get the authorization details associated with the current API token
post
Invalidate current token
post
Invalidate existing token and generates new token
post
Get all the Authorization details associated with the current api
get
Invalidate current token
post
Invalidate existing token and generates new token
post
Create a token based on other authentication details (basic, etc.)
post
Obtain an access token using an API Client
post
api-integrations
Get the current API Integrations
get
Create API integration object
post
Get specified API integration object
get
Update specified API integration object
put
Remove specified API integration
delete
Create client credentials for specified API integration
post
api-role-privileges
Get the current Jamf API Role Privileges
get
Search the current Jamf API Role Privileges
get
api-roles
Get the current Jamf API Roles
get
Create a new API role
post
Get the specific Jamf API Role
get
Update API Integrations Role
put
Delete API Integrations Role
delete
app-request-preview
Search for Form Input Fields
get
Replace all Form Input Fields
put
Create Form Input Field record
post
Get specified Form Input Field object
get
Update specified Form Input Field object
put
Remove specified Form Input Field record
delete
Get Applicastion Request Settings
get
Update Application Request Settings
put
app-store-country-codes-preview
Return a list of Countries and the associated Codes
get
branding
Download a self service branding image
get
buildings
Search for sorted and paged Buildings
get
Create Building record
post
Delete multiple Buildings by their ids
post
Export Buildings collection
post
Get specified Building object
get
Update specified Building object
put
Remove specified Building record
delete
Get specified Building History object
get
Add specified Building history object notes
post
Export history object collection in specified format for specified Buildings
post
cache-settings
Get Cache Settings
get
Update Cache Settings
put
categories
Get Category objects
get
Create Category record
post
Delete multiple Categories by their IDs
post
Get specified Category object
get
Update specified Category object
put
Remove specified Category record
delete
Get specified Category history object
get
Add specified Category history object notes
post
certificate-authority
Returns X.509 details of the active Certificate Authority (CA)
get
Returns X.509 of active Certificate Authority (CA) in DER format
get
Returns active Certificate Authority (CA) in PEM format
get
Returns X.509 details of Certificate Authority (CA) with provided ID
get
Returns X.509 current Certificate Authority (CA) with provided ID in DER format
get
Returns current Certificate Authority (CA) with provided ID in PEM format
get
classic-ldap
Get mappings for OnPrem Ldap configuration with given id.
get
client-check-in
Get Client Check-In settings
get
Update Client Check-In object
put
Get Client Check-In history object
get
Add a Note to Client Check-In History
post
cloud-azure
Create Azure Cloud Identity Provider configuration
post
Get default mappings
get
Get default server configuration
get
Get Azure Cloud Identity Provider configuration with given ID.
get
Update Azure Cloud Identity Provider configuration
put
Delete Cloud Identity Provider configuration.
delete
cloud-distribution-point
Get the Cloud Distribution Point Details.
get
Create Cloud Distribution Point
post
Delete Cloud Distribution Point.
delete
Update specific fields on a Cloud Distribution Point
patch
Get Cloud Distribution Point history details
get
Add specified Cloud Distribution Point history object notes
post
Get the Cloud Distribution Point Inventory files details
get
Get the Cloud Distribution Point test connection details.
get
Finds specific information for the currently configured Cloud Distribution Point.
get
cloud-idp
Get information about all Cloud Identity Providers configurations.
get
Export Cloud Identity Providers collection
post
Get Cloud Identity Provider configuration with given ID.
get
Get Cloud Identity Provider history
get
Add Cloud Identity Provider history note
post
Get group test search
post
Get user test search
post
Get membership test search
post
cloud-information
Retrieve information related to cloud setup.
get
cloud-ldap
Validate keystore for Cloud Identity Provider secure connection
post
Create Cloud Identity Provider configuration
post
Get default mappings
get
Get default server configuration
get
Get Cloud Identity Provider configuration with given id.
get
Update Cloud Identity Provider configuration
put
Delete Cloud Identity Provider configuration.
delete
Get bind connection pool statistics
get
Get search connection pool statistics
get
Tests the communication with the specified cloud connection
get
Get mappings configurations for Cloud Identity Providers server configuration.
get
Update Cloud Identity Provider mappings configuration.
put
computer-extension-attributes
Retrieve Computer Extension Attributes.
get
Create Computer Extension Attribute.
post
Delete multiple Computer Extension Attribute at once.
post
Retrieve All Computer Extension Attributes Templates.
get
Get specified Computer Extension Attribute Template object.
get
Upload Computer Extension Attribute.
post
Get specified Computer Extension Attribute object.
get
Update specified Computer Extension Attribute object.
put
Remove specified Computer Extension Attribute.
delete
Get smart group/advance search dependent objects for a specified computer extension attribute
get
Download the specified Computer Extension Attribute.
get
Get specified Computer Extension Attribute History object
get
Add specified Computer Extension Attribute history object notes
post
computer-groups
Returns the list of all computer groups
get
Get the membership of a Smart Computer Group
get
Search for Smart Computer Groups
get
Create a Smart Computer Group
post
Update a Smart Computer Group
put
Remove specified Smart Computer Group
delete
computer-inventory
Erase a computer
post
Remove a computer's MDM profile
post
Return paginated Computer Inventory records
get
Return all sections of a computer
get
Update specific fields on a computer
patch
Return paginated FileVault information for all computers
get
Return General section of a Computer
get
Remove specified Computer record
delete
Upload attachment and assign to computer
post
Download attachment file
get
Remove attachment
delete
Return FileVault information for a specific computer
get
Return a computer's Device Lock PIN
get
Return a Computers Recovery Lock Password
get
computer-inventory-collection-settings
Returns computer inventory settings
get
Update computer inventory settings
patch
Create Computer Inventory Collection Settings Custom Path
post
Delete Custom Path from Computer Inventory Collection Settings
delete
computer-prestages
Get all device Scope for all Computer Prestages
get
Get device Scope for a specific Computer Prestage
get
Replace device Scope for a specific Computer Prestage
put
Add device Scope for a specific Computer Prestage
post
Remove device Scope for a specific Computer Prestage
delete
Get sorted and paged Computer Prestages
get
Create a Computer Prestage
post
Get all device Scope for all Computer Prestages
get
Retrieve a Computer Prestage with the supplied id
get
Update a Computer Prestage
put
Delete a Computer Prestage with the supplied id
delete
Get device Scope for a specific Computer Prestage
get
Replace device Scope for a specific Computer Prestage
put
Add device Scope for a specific Computer Prestage
post
Remove device Scope for a specific Computer Prestage
post
Get sorted and paged Computer Prestages
get
Create a Computer Prestage
post
Retrieve a Computer Prestage with the supplied id
get
Update a Computer Prestage
put
Delete a Computer Prestage with the supplied id
delete
computers-preview
Return a list of Computers
get
conditional-access
Get compliance information for a single computer device
get
Get compliance information for a single mobile device
get
Retrieves Status of the Feature Toggle
get
csa
Returns the CSA tenant ID.
get
Get details regarding the CSA token exchange
get
Delete the CSA token exchange - This will disable Jamf Pro's ability to authenticate with cloud-hosted services
delete
dashboard
Get all the dashboard setup information
get
declarative-device-management
Retrieve the Status Items from the latest Status Report for a device
get
Retrieve a Status Item from the latest Status Report for a device
get
Force a device DDM sync
post
departments
Search for Departments
get
Create department record
post
Deletes all departments by ids passed in body
post
Get specified Department object
get
Update specified department object
put
Remove specified department record
delete
Get specified Department history object
get
Add specified Department history object notes
post
device-communication-settings
Retrieves all settings for device communication
get
Update device communication settings
put
Get Device Communication settings history
get
Add Device Communication Settings history notes
post
device-enrollments
Read all sorted and paged Device Enrollment instances
get
Retrieve the Jamf Pro Device Enrollment public key
get
Get all instance sync states for all Device Enrollment Instances
get
Create a Device Enrollment Instance with the supplied Token
post
Retrieve a Device Enrollment Instance with the supplied id
get
Update a Device Enrollment Instance with the supplied id
put
Delete a Device Enrollment Instance with the supplied id
delete
Disown devices from the given Device Enrollment Instance
post
Get sorted and paged Device Enrollment history objects
get
Add Device Enrollment history object notes
post
Get all instance sync states for a single Device Enrollment Instance
get
Get the latest sync state for a single Device Enrollment Instance
get
Update a Device Enrollment Instance with the supplied Token
put
device-enrollments-devices
Retrieve a list of Devices assigned to the supplied id
get
distribution-point
Finds all Distribution Points
get
Create distribution point
post
Delete multiple distribution points at once
post
Get specified distribution point
get
Update specified distribution point object
put
Remove specified distribution point
delete
Update specified distribution point object
patch
Get specified distribution point History object
get
Add specified distribution point History object notes
post
dock-items
Create a DockItem
post
Retrieve a full dockItem object
get
Replace the dockItem at the id with the supplied information
put
Delete a DockItem at the specified id
delete
dss-declarations
Retrieve a declaration from DSS
get
ebooks
Get Ebook object
get
Get specified Ebook object
get
Get specified scope of Ebook object
get
engage
Get Engage settings
get
Update Engage settings
put
Get Engage settings history
get
Add Engage settings history notes
post
enrollment
Retrieve the Account Driven User Enrollment Session Token Settings
get
Update Account Driven User Enrollment Session Token Settings.
put
Get Enrollment object and Re-enrollment settings
get
Update Enrollment object
put
Retrieve the configured LDAP groups configured for User-Initiated Enrollment
get
Add the configured LDAP group for User-Initiated Enrollment.
post
Retrieve the configured LDAP groups configured for User-Initiated Enrollment
get
Modify the configured LDAP groups configured for User-Initiated Enrollment
put
Delete an LDAP group's access to user initiated Enrollment
delete
Retrieve the list of languages and corresponding ISO 639-1 Codes but only those not already added to Enrollment
get
Get sorted and paged Enrollment history object
get
Add Enrollment history object notes
post
Export enrollment history collection
post
Retrieve the list of languages and corresponding ISO 639-1 Codes
get
Get an array of the language codes that have Enrollment messaging
get
Delete multiple configured languages from User-Initiated Enrollment settings
post
Retrieve the Enrollment messaging for a language
get
Edit Enrollment messaging for a language
put
Delete the Enrollment messaging for a language
delete
Get Enrollment object and Re-enrollment settings
get
Update Enrollment object
put
Retrieve the configured LDAP groups configured for User-Initiated Enrollment.
get
Add the configured LDAP group for User-Initiated Enrollment.
post
Retrieve the configured LDAP groups configured for User-Initiated Enrollment
get
Modify the configured LDAP groups configured for User-Initiated Enrollment. Only exiting Access Groups can be updated.
put
Delete an LDAP group's access to user initiated Enrollment.
delete
Retrieve the list of languages and corresponding ISO 639-1 Codes but only those not already added to Enrollment
get
Retrieve the list of languages and corresponding ISO 639-1 Codes
get
Get an array of the language codes that have Enrollment messaging
get
Delete multiple configured languages from User-Initiated Enrollment settings
post
Retrieve the Enrollment messaging for a language
get
Edit Enrollment messaging for a language
put
Delete the Enrollment messaging for a language
delete
Get Enrollment object and Re-enrollment settings
get
Update Enrollment object
put
enrollment-customization
Retrieve sorted and paged Enrollment Customizations
get
Create an Enrollment Customization
post
Upload an image
post
Retrieve an Enrollment Customization with the supplied id
get
Update an Enrollment Customization
put
Delete an Enrollment Customization with the supplied id
delete
Get sorted and paged Enrollment Customization history objects
get
Add Enrollment Customization history object notes
post
Retrieve the list of Prestages using this Enrollment Customization
get
Retrieve sorted and paged Enrollment Customizations
get
Create an Enrollment Customization
post
Upload an image
post
Download an enrollment customization image
get
Retrieve an Enrollment Customization with the supplied id
get
Update an Enrollment Customization
put
Delete an Enrollment Customization with the supplied id
delete
Get sorted and paged Enrollment Customization history objects
get
Add Enrollment Customization history object notes
post
Retrieve the list of Prestages using this Enrollment Customization
get
enrollment-customization-preview
Parse the given string as markdown text and return Html output
post
Get all Panels for single Enrollment Customization
get
Get a single Panel for a single Enrollment Customization
get
Delete a single Panel from an Enrollment Customization
delete
Create an LDAP Panel for a single Enrollment Customization
post
Get a single LDAP panel for a single Enrollment Customization
get
Update a single LDAP Panel for a single Enrollment Customization
put
Delete an LDAP single panel from an Enrollment Customization
delete
Create an SSO Panel for a single Enrollment Customization
post
Get a single SSO Panel for a single Enrollment Customization
get
Update a single SSO Panel for a single Enrollment Customization
put
Delete a single SSO Panel from an Enrollment Customization
delete
Create a Text Panel for a single Enrollment Customization
post
Get a single Text Panel for a single Enrollment Customization
get
Update a single Text Panel for a single Enrollment Customization
put
Delete a Text single Panel from an Enrollment Customization
delete
Get the markdown output of a single Text Panel for a single Enrollment
get
groups
Returns group information for all Mobile Device and Computer groups
get
Returns group information for the given platform UUID
get
gsx-connection
Finds the Jamf Pro GSX Connection information
get
Updates Jamf Pro GSX Connection information
put
Updates Jamf Pro GSX Connection information
patch
Get specified GSX Connection History object
get
Add specified GSX Connection history object notes
post
Test functionality of an GSX Connection
post
health-check
Get Jamf Pro API status
get
icon
Upload an icon
post
Download a self service icon
get
Get an icon
get
inventory-information
Get statistics about managed/unmanaged devices and computers in the inventory
get
inventory-preload
Return all Inventory Preload records
get
Create a new Inventory Preload record using JSON or CSV
post
Delete all Inventory Preload records
delete
Get the Inventory Preload CSV template
get
Get Inventory Preload history entries
get
Add Inventory Preload history object notes
post
Validate a given CSV file
post
Get an Inventory Preload record
get
Update an Inventory Preload record
put
Delete an Inventory Preload record
delete
Return all Inventory Preload records
get
Create a new Inventory Preload record using JSON or CSV
post
Delete all Inventory Preload records
delete
Retrieve the Inventory Preload CSV template
get
Get Inventory Preload history entries
get
Add Inventory Preload history object notes
post
Validate a given CSV file
post
Get an Inventory Preload record
get
Update an Inventory Preload record
put
Delete an Inventory Preload record
delete
Download all Inventory Preload records
get
Create one or more new Inventory Preload records using CSV
post
Download the Inventory Preload CSV template
get
Validate a given CSV file
post
Retrieve a list of extension attribute columns
get
Export a collection of inventory preload records
post
Get Inventory Preload history entries
get
Add Inventory Preload history object notes
post
Return all Inventory Preload records
get
Create a new Inventory Preload record using JSON
post
Delete all Inventory Preload records
post
Get an Inventory Preload record
get
Update an Inventory Preload record
put
Delete an Inventory Preload record
delete
jamf-cloud-distribution-service
Retrieve a list of files and file metadata from the Jamf Cloud Distribution Service
get
Initiate an upload to the Jamf Cloud Distribution Service
post
Retrieve a download URL for a specific file from the Jamf Cloud Distribution Service
get
Delete a file from the Jamf Cloud Distribution Service
delete
Gets information about JCDS distribution points.
get
Refreshes the inventory and status of uploads in Jamf Pro. This will update the status of uploads in the Jamf Pro database and allow the uploads to be deployed.
post
Renew credentials for an upload to the Jamf Cloud Distribution Service
post
jamf-connect
Get the Jamf Connect settings that you have access to see
get
Search for config profiles linked to Jamf Connect
get
Update the way the Jamf Connect app gets updated on computers within scope of the associated configuration profile.
put
Search for deployment tasks for a config profile linked to Jamf Connect
get
Request a retry of Connect install tasks
post
Get Jamf Connect history
get
Add Jamf Connect history notes
post
jamf-management-framework
Redeploy Jamf Management Framework
post
jamf-package
Get the packages for a given Jamf application
get
Get the packages for a given Jamf application
get
jamf-pro-account-preferences
Get Jamf Pro account preferences
get
Update Jamf Pro account preferences
patch
jamf-pro-information
Get basic information about the Jamf Pro Server
get
Get basic information about the Jamf Pro Server
get
jamf-pro-initialization
Set up fresh installed Jamf Pro Server
post
Provide Database Password during startup
post
jamf-pro-notifications
Get Notifications for user and site
get
Delete Notifications
delete
jamf-pro-server-url-preview
Get Jamf Pro Server URL settings
get
Update Jamf Pro Server URL settings
put
Get Jamf Pro Server URL settings history
get
Add Jamf Pro Server URL settings history notes
post
jamf-pro-user-account-settings
Get the user preferences for the authenticated user and key.
get
Get the user setting for the authenticated user and key
get
Persist the user setting
put
Remove specified setting for authenticated user
delete
jamf-pro-user-account-settings-preview
Get the user setting for the authenticated user and key
get
Persist the user setting
put
Remove specified setting for authenticated user
delete
jamf-pro-version
Return information about the Jamf Pro including the current version
get
jamf-protect
Jamf Protect integration settings
get
Jamf Protect integration settings
put
Delete Jamf Protect API registration.
delete
Search for deployment tasks for a config profile linked to Jamf Protect
get
Request a retry of Protect install tasks
post
Get Jamf Protect history
get
Add Jamf Protect history notes
post
Get all of the previously synced Jamf Protect Plans with information about their associated configuration profile
get
Sync Plans with Jamf Protect
post
Register a Jamf Protect API configuration with Jamf Pro
post
jamf-remote-assist
Gets session history items.
get
Gets single session history item.
get
Gets session history items.
get
Export Jamf Remote Assist sessions history
post
Gets single session history item.
get
ldap
Retrieve the configured access groups that contain the text in the search param
get
Retrieve all Servers including LDAP and Cloud Identity Providers.
get
Retrieve the configured access groups that contain the text in the search param
get
Retrieve all LDAP Servers.
get
Retrieve all Servers including LDAP and Cloud Identity Providers.
get
local-admin-password
Get a list of the current devices and usernames with pending LAPS rotations
get
Get the current LAPS settings.
get
Update settings for LAPS.
put
Get LAPS password viewed history.
get
Get LAPS historical records for target device and username.
get
Get current LAPS password for specified username on a client.
get
Get LAPS password viewed history.
get
Get LAPS historical records for target device and user guid.
get
Get current LAPS password for specified user guid on a client.
get
Get the LAPS capable admin accounts for a device.
get
Get LAPS password viewed history, and rotation history.
get
Set the LAPS password for a device.
put
locales-preview
Return locales that can be used in other features
get
log-flushing
Get log flushing settings
get
Get log flushing tasks
get
Queue a log flushing task
post
Get log flushing task
get
Cancels a log flushing task
delete
login-customization
Get current login disclaimer settings
get
Update current login disclaimer settings.
put
macos-managed-software-updates
Retrieve available MacOs Managed Software Updates
get
Send MacOs Managed Software Updates
post
managed-software-updates
Retrieve available macOS and iOS Managed Software Updates
get
Retrieve Managed Software Update Plans
get
Create a Managed Software Update Plan
post
Retrieve current value of the Feature Toggle
get
Updates Feature Toggle Value
put
Force stops any ongoing or stalled feature-toggle processes
post
Retrieves background status of the Feature Toggle
get
Create Managed Software Update Plans for a Group
post
Retrieve Managed Software Update Plans for a Group
get
Retrieve a Managed Software Update Plan
get
Retrieve all Declarations associated with a Managed Software Update Plan
get
Retrieve a Managed Software Update Plan Event Store
get
Retrieve Managed Software Update Statuses
get
Retrieve Managed Software Update Statuses for Computer Groups
get
Retrieve Managed Software Update Statuses for Computers
get
Retrieve Managed Software Update Statuses for Mobile Device Groups
get
Retrieve Managed Software Update Statuses for Mobile Devices
get
mdm
Post a command for creation and queuing
post
Deploy packages using MDM
post
Get information about mdm commands made by Jamf Pro.
get
Renew MDM Profile
post
Get information about mdm commands made by Jamf Pro.
get
Post a command for creation and queuing
post
mobile-device-apps
Reinstall App Config for Managed iOS Apps
post
mobile-device-enrollment-profile
Retrieve the MDM Enrollment Profile
get
mobile-device-extension-attributes-preview
Get Mobile Device Extension Attribute values placed in select paramter
get
mobile-device-groups
Return the list of all Mobile Device Groups
get
Get Static Group Membership by Id
get
Get Static Groups
get
Create membership of a static group.
post
Get Static Group by Id
get
Remove Static Group by Id
delete
Update membership of a static group.
patch
mobile-device-prestages
Search for sorted and paged Mobile Device Prestages
get
Create a Mobile Device Prestage
post
Get all Device Scope for all Mobile Device Prestages
get
Get all Prestage sync States for all prestages
get
Get all prestage sync states for a single prestage
get
Get the latest Sync State for a single Prestage
get
Retrieve a Mobile Device Prestage with the supplied id
get
Update a Mobile Device Prestage
put
Delete a Mobile Device Prestage with the supplied id
delete
Get attachments for a Mobile Device Prestage
get
Add an attachment to a Mobile Device Prestage
post
Remove an attachment for a Mobile Device Prestage
delete
Get sorted and paged Mobile Device Prestage history objects
get
Add Mobile Device Prestage history object notes
post
Get Device Scope for a specific Mobile Device Prestage
get
Replace Device Scope for a specific Mobile Device Prestage
put
Add Device Scope for a specific Mobile Device Prestage
post
Remove Device Scope for a specific Mobile Device Prestage
delete
Get sorted and paged Mobile Device Prestages
get
Create a Mobile Device Prestage
post
Get all Device Scope for all Mobile Device Prestages
get
Get all Prestage sync States for all prestages
get
Retrieve a Mobile Device Prestage with the supplied id
get
Update a Mobile Device Prestage
put
Delete a Mobile Device Prestage with the supplied id
delete
Get attachments for a Mobile Device Prestage
get
Add an attachment to a Mobile Device Prestage
post
Remove an attachment for a Mobile Device Prestage
post
Get sorted and paged Mobile Device Prestage history objects
get
Add Mobile Device Prestage history object notes
post
Get Device Scope for a specific Mobile Device Prestage
get
Replace Device Scope for a specific Mobile Device Prestage
put
Add Device Scope for a specific Mobile Device Prestage
post
Remove Device Scope for a specific Mobile Device Prestage
post
Get all prestage sync states for a single prestage
get
Get the latest Sync State for a single Prestage
get
mobile-devices
Get Mobile Device objects
get
Return paginated Mobile Device Inventory records
get
Get Mobile Device
get
Update fields on a mobile device that are allowed to be modified by users
patch
Get Mobile Device
get
Erase a Mobile Device
post
Return paginated Mobile Device Inventory records of all paired devices for the device
get
Unmanage a Mobile Device
post
oidc
Provide the url to redirect for OIDC login
post
Generate a new keystore used for signing OIDC messages
post
Get the public key of the keystore used for signing OIDC messages as a JWT
get
onboarding
Get the current onboarding settings configuration.
get
Update the onboarding configuration.
put
Retrieves a list of applications that are eligible to be used in an onboarding configuration
get
Retrieves a list of configuration profiles that are eligible to be used in an onboarding configuration
get
Retrieves a list of policies that are eligible to be used in an onboarding configuration
get
Get Onboarding history object
get
Add Onboarding history object notes
post
Export history object collection in specified format for Onboarding
post
packages
Retrieve Packages
get
Create package
post
Delete multiple packages at once
post
Export Packages collection
post
Get specified Package object
get
Update specified package object
put
Remove specified package
delete
Get specified Package History object
get
Add specified Package history object notes
post
Export history object collection in specified format for specified Packages
post
Add a manifest to a package
post
Delete the manifest for a specified package
delete
Upload package
post
parent-app-preview
Get the current Jamf Parent app settings
get
Update Jamf Parent app settings
put
Get Jamf Parent app settings history
get
Add Jamf Parent app settings history notes
post
patch-management
Accept Patch Management disclaimer
post
patch-policies
Retrieve Patch Policies
get
Retrieve Patch Policies
get
Return whether or not the requested patch policy is on the dashboard
get
Add a patch policy to the dashboard
post
Remove a patch policy from the dashboard
delete
patch-policy-logs
Retrieve Patch Policy Logs
get
Return the count of the Patch Policy Logs for the patch policy id that are eligible for a retry attempt
get
Send retry attempts for specific devices
post
Send retry attempts for all devices
post
Retrieves a single Patch Policy Log
get
Return attempt details for a specific log
get
patch-software-title-configurations
Retrieve Patch Software Title Configurations
get
Create Patch Software Title Configurations
post
Retrieve Patch Software Title Configurations with the supplied id
get
Delete Patch Software Title Configurations with the supplied id
delete
Update Patch Software Title Configurations
patch
Return whether or not the requested software title configuration is on the dashboard
get
Add a software title configuration to the dashboard
post
Remove a software title configuration from the dashboard
delete
Retrieve Patch Software Title Definitions with the supplied id
get
Retrieve list of Patch Software Title Configuration Dependencies
get
Export Patch Reporting Data
get
Retrieve Software Title Extension Attributes with the supplied id
get
Get specified Patch Software Title Configuration history object
get
Add Patch Software Title Configuration history object notes
post
Retrieve Patch Software Title Configuration Patch Report
get
Return Active Patch Summary
get
Returns patch versions
get
policies-preview
Get Policy Properties object
get
Update Policy Properties object
put
Get Policy Properties object
get
Update Policy Properties object
put
re-enrollment-preview
Get Re-enrollment object
get
Update the Re-enrollment object
put
Get Re-enrollment history object
get
Add specified Re-enrollment history object notes
post
Export reenrollment history collection
post
remote-administration
Get information about all remote administration configurations.
get
return-to-service
Get all Return to Service Configurations
get
Create a Return to Service Configuration
post
Retrieve a Return to Service Configuration with the supplied id
get
Update a Return to Service Configuration
put
Delete a Return To Service Configuration with the supplied id
delete
scheduler
Retrieve all Jamf Pro Scheduler jobs
get
Retrieve all triggers for a Jamf Pro Scheduler job
get
Retrieve a summary of the Jamf Pro Scheduler
get
scripts
Search for sorted and paged Scripts
get
Create a Script
post
Retrieve a full script object
get
Replace the script at the id with the supplied information
put
Delete a Script at the specified id
delete
Download a text file of the Script contents
get
Get specified Script history object
get
Add specified Script history object notes
post
self-service
Get an object representation of Self Service settings
get
Put an object representation of Self Service settings
put
self-service-branding-ios
Search for sorted and paged iOS branding configurations
get
Create a Self Service iOS branding configuration with the supplied
post
Read a single Self Service iOS branding configuration indicated by the provided id
get
Update a Self Service iOS branding configuration with the supplied details
put
Delete the Self Service iOS branding configuration indicated by the provided id
delete
self-service-branding-macos
Search for sorted and paged macOS branding configurations
get
Create a Self Service macOS branding configuration with the supplied
post
Read a single Self Service macOS branding configuration indicated by the provided id
get
Update a Self Service macOS branding configuration with the supplied details
put
Delete the Self Service macOS branding configuration indicated by the provided id
delete
self-service-branding-preview
Upload an image
post
sites
Find all sites
get
Find and filter site objects for a site ID
get
sites-preview
Find all sites
get
slasa
Get the status of SLASA
get
Accept the SLASA
post
smart-computer-groups-preview
Recalculate a smart group for the given id
post
Recalculate the smart group for the given id
post
smart-mobile-device-groups-preview
Recalculate all smart groups for the given device id and then return count of smart groups that device fall into
post
Recalculate a smart group for the given id then return the ids for the devices in the smart group
post
smart-user-groups-preview
Recalculate the smart group for the given id and then return the ids for the users in the smart group
post
Recalculate a smart group for the given user id and then return the count of smart groups the user falls into
post
smtp-server
Finds the Jamf Pro SMTP Server information
get
Updates Jamf Pro SMTP Server information
put
Get specified SMTP Server history object
get
Add SMTP Server history object notes
post
Test functionality of an SMTP Server
post
Finds the Jamf Pro SMTP Server information
get
Updates Jamf Pro SMTP Server information
put
sso-certificate
Retrieve the certificate currently configured for use with SSO
get
Update the certificate used by Jamf Pro to sign SSO requests to the identify provider
put
Jamf Pro will generate a new certificate and use it to sign SSO
post
Delete the currently configured certificate used by SSO
delete
Download the certificate currently configured for use with Jamf Pro's SSO configuration
get
Parse the certificate to get details about certificate type and keys needed to upload certificate file
post
sso-failover
Retrieve the current failover settings
get
Regenerates failover url
post
sso-oauth-session-tokens
Retrieve the access token and user information for the current session.
get
sso-settings
Retrieve the current Single Sign On configuration settings
get
Updates the current Single Sign On configuration settings
put
Retrieve the list of Enrollment Customizations using SSO
get
Disable SSO
post
Get SSO history object
get
Add SSO history object notes
post
Download the Jamf Pro SAML metadata file
get
Endpoint for validation of a saml metadata url
post
Retrieve the current Single Sign On configuration settings
get
Updates the current Single Sign On configuration settings
put
Retrieve the list of Enrollment Customizations using SSO
get
Disable SSO
post
Get SSO history object
get
Add SSO history object notes
post
Download the Jamf Pro SAML metadata file
get
startup-status
Retrieve information about application startup
get
static-user-groups-preview
Return a list of all Static User Groups
get
Return a specific Static User Group by id
get
supervision-identities-preview
Search for sorted and paged Supervision Identities
get
Create a Supervision Identity for the supplied information
post
Upload the Supervision Identity .p12 file
post
Retrieve a Supervision Identity with the supplied id
get
Update a Supervision Identity with the supplied information
put
Delete a Supervision Identity with the supplied id
delete
Download the Supervision Identity .p12 file
get
teacher-app
Get the Jamf Teacher settings that you have access to see
get
Update a Jamf Teacher settings object
put
Get Jamf Teacher app settings history
get
Add Jamf Teacher app settings history notes
post
team-viewer-remote-administration
Create Team Viewer Remote Administration connection configuration
post
Get a paginated list of sessions
get
Create a new session
post
Get a session by its ID
get
Close a session
post
Resend nofications for a session
post
Get a session status by its ID
get
Get Team Viewer Remote Administration connection configuration
get
Delete Team Viewer Remote Administration connection configuration
delete
Update Team Viewer Remote Administration connection configuration
patch
Get Team Viewer Remote Administration connection status
get
time-zones-preview
Return information about the currently supported Time Zones
get
tomcat-settings-preview
Generate a SSL Certificate using Jamf Certificate Authority
post
user
Changes the user account password.
post
user-session-preview
Return all Jamf Pro user acounts
get
Update values in the User's current session
post
venafi-preview
Create a PKI configuration in Jamf Pro for Venafi
post
Retrieve a Venafi PKI configuration from Jamf Pro
get
Delete a Venafi PKI configuration from Jamf Pro
delete
Update a Venafi PKI configuration in Jamf Pro
patch
Tests the communication between Jamf Pro and a Jamf Pro PKI Proxy Server
get
Get configuration profile data using specified Venafi CA object
get
Get specified Venafi CA history object
get
Add specified Venafi CA Object Note
post
Downloads a certificate used to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server
get
Regenerates a certificate used to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server
post
Downloads the PKI Proxy Server public key to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server
get
Uploads the PKI Proxy Server public key to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server
post
Removes the PKI Proxy Server public key used to secure communication between Jamf Pro and a Jamf Pro PKI Proxy Server
delete
volume-purchasing-locations
Retrieve Volume Purchasing Locations
get
Create a Volume Purchasing Location
post
Retrieve a Volume Purchasing Location with the supplied id
get
Delete a Volume Purchasing Location with the supplied id
delete
Update a Volume Purchasing Location
patch
Retrieve the Volume Purchasing Content for the Volume Purchasing Location with the supplied id
get
Get specified Volume Purchasing Location history object
get
Add specified Volume Purchasing Location history object notes
post
Reclaim a Volume Purchasing Location with the supplied id
post
Revoke licenses for a Volume Purchasing Location with the supplied id
post
volume-purchasing-subscriptions
Retrieve Volume Purchasing Subscriptions
get
Create a Volume Purchasing Subscription
post
Retrieve a Volume Purchasing Subscription with the supplied id
get
Update a Volume Purchasing Subscription
put
Delete a Volume Purchasing Subscription with the supplied id
delete
Get specified Volume Purchasing Subscription history object
get
Add Volume Purchasing Subscription history object notes
post
Title Editor
auth
Get token claims
post
Refresh token
post
Send token
post
Create token
post
capabilities
Update capability
put
Delete capability
delete
codesigning
Get certificate info
get
Update certificate
put
Delete certificate
delete
components
Get component
get
Update component
put
Delete component
delete
Create criteria
post
Get autofill criteria
get
Get navigation
get
criteria
Update criteria
put
Delete criteria
delete
extensionattributes
Get extension attribute
get
Update extension attribute
put
Delete extension attribute
delete
Get navigation
get
externaltitles
Get available titles
get
Refresh subscribed titles
post
Get subscribed title
get
Get definition
get
Get override
get
Set override
put
Delete override
delete
Get kill apps
get
Create kill app
post
Get autofill kill apps
get
killapps
Get kill app
get
Update kill app
put
Delete kill app
delete
Get navigation
get
overrides
Get override kill app
get
Update override kill app
put
Delete override kill app
delete
Get navigation
get
patches
Get patch
get
Update patch
put
Delete patch
delete
Create capability
post
Get autofill capabilities
get
Create component
post
Get autofill components
get
Create kill app
post
Get autofill kill apps
get
Get navigation
get
Clone patch
post
preferences
Get preference
get
Set preference
put
Delete preference
delete
privileges
Delete privilege
delete
requirements
Update requirement
put
Delete requirement
delete
smtpserver
Get smtp server
get
Update smtp server
put
Test smtp server
post
Delete smtp server
delete
softwaretitles
Get software titles
get
Create software title
post
Get software title
get
Update software title
put
Delete software title
delete
Create extension attribute
post
Create patch
post
Get autofill patches
get
Create requirement
post
Get autofill requirements
get
sources
Get sources
get
Create source
post
Get source
get
Update source
put
Delete source
delete
users
Get users
get
Create user
post
Get user
get
Update user
put
Delete user
delete
Get privileges
get
Create privilege
post
valuelists
Get authentication schemes
get
Get criteria names
get
Get criteria operators
post
Get criteria types
get
Get preference keys
get
Get preference types
get
Get privilege scopes
get
Get smtp encryption types
get
Search for Departments
get
https://yourServer.jamfcloud.com/api/v1/departments
Search for Departments
Language
Shell
Swift
Ruby
Python
Credentials
Bearer
Log in to use your API keys
