Jump to Content

Home Guides Recipes API Reference Changelog

API Reference

Home Guides Recipes API Reference Changelog

Classic API Introduction

Getting Started

Classic API

accounts
activationcode
- Finds the Jamf Pro activation codeget
- Updates the Jamf Pro activation codeput
advancedcomputersearches
advancedmobiledevicesearches
advancedusersearches
allowedfileextensions
buildings
byoprofiles
categories
classes
commandflush
- Flushes commands based on information specified in an XML filedelete
- Flushes commands for devicesdelete
computerapplications
computerapplicationusage
computercheckin
- Finds the Jamf Pro computer checkin informationget
- Updates the Jamf Pro computer checkin informationput
computercommands
computerextensionattributes
computergroups
computerhardwaresoftwarereports
computerhistory
computerinventorycollection
- Finds the Jamf Pro computer inventory collection informationget
- Updates the Jamf Pro computer inventory collection informationput
computerinvitations
computermanagement
computerreports
computers
departments
directorybindings
diskencryptionconfigurations
distributionpoints
dockitems
ebooks
fileuploads
- Creates file attachments in Jamf Propost
gsxconnection
- Finds the Jamf Pro GSX connection informationget
- Updates the Jamf Pro GSX connection informationput
healthcarelistener
healthcarelistenerrule
ibeacons
infrastructuremanager
jssuser
- Returns basic information about Jamf Pro, as well as privileges of the person requesting the resource. (Deprecated)get
jsonwebtokenconfigurations
ldapservers
licensedsoftware
logflush
macapplications
managedpreferenceprofiles
mobiledeviceapplications
mobiledevicecommands
mobiledeviceconfigurationprofiles
mobiledeviceenrollmentprofiles
mobiledeviceextensionattributes
mobiledevicegroups
mobiledevicehistory
mobiledeviceinvitations
mobiledeviceprovisioningprofiles
mobiledevices
networksegments
osxconfigurationprofiles
packages
patchavailabletitles
- Finds all available title from a source by IDget
patches
patchexternalsources
patchinternalsources
patchpolicies
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
peripherals
peripheraltypes
policies
printers
removablemacaddresses
restrictedsoftware
savedsearches
scripts
sites
smtpserver
- Finds the Jamf Pro SMTP server informationget
- Updates the Jamf Pro SMTP server informationput
softwareupdateservers
userextensionattributes
usergroups
users
vppaccounts
vppassignments
vppinvitations
webhooks

Jamf Pro API Introduction

Getting Started

Jamf Pro API

advanced-mobile-device-searches
advanced-user-content-searches
api-authentication
api-integrations
api-role-privileges
- Get the current Jamf API Role Privilegesget
- Search the current Jamf API Role Privilegesget
api-roles
app-request-preview
app-store-country-codes-preview
- Return a list of Countries and the associated Codesget
branding
- Download a self service branding imageget
buildings
cache-settings
- Get Cache Settingsget
- Update Cache Settingsput
categories
certificate-authority
classic-ldap
- Get mappings for OnPrem Ldap configuration with given id.get
client-check-in
cloud-azure
cloud-idp
cloud-information
- Retrieve information related to cloud setup.get
cloud-ldap
computer-groups
- Returns the list of all computer groupsget
computer-inventory
computer-inventory-collection-settings
computer-prestages
computers-preview
- Return a list of Computersget
conditional-access
- Get compliance information for a single computer deviceget
- Get compliance information for a single mobile deviceget
csa
dashboard
- Get all the dashboard setup informationget
departments
device-communication-settings
device-enrollments
device-enrollments-devices
- Retrieve a list of Devices assigned to the supplied idget
ebooks
engage
enrollment
enrollment-customization
enrollment-customization-preview
icon
inventory-information
- Get statistics about managed/unmanaged devices and computers in the inventoryget
inventory-preload
jamf-connect
jamf-management-framework
- Redeploy Jamf Management Frameworkpost
jamf-package
- Get the packages for a given Jamf applicationget
- Get the packages for a given Jamf applicationget
jamf-pro-information
- Get basic information about the Jamf Pro Serverget
- Get basic information about the Jamf Pro Serverget
jamf-pro-initialization
- Set up fresh installed Jamf Pro Serverpost
- Provide Database Password during startuppost
jamf-pro-initialization-preview
- Set up fresh installed Jamf Pro Serverpost
- Provide Database Password during startuppost
jamf-pro-notifications
- Get Notifications for user and siteget
- Delete Notificationsdelete
jamf-pro-notifications-preview
jamf-pro-server-url-preview
jamf-pro-user-account-settings
jamf-pro-user-account-settings-preview
jamf-pro-version
- Return information about the Jamf Pro including the current versionget
jamf-protect
ldap
local-admin-password
locales-preview
- Return locales that can be used in other featuresget
macos-managed-software-updates
- Retrieve available MacOs Managed Software Updatesget
- Send MacOs Managed Software Updatespost
managed-software-updates
mdm
mobile-device-apps
- Reinstall App Config for Managed iOS Appspost
mobile-device-enrollment-profile
- Retrieve the MDM Enrollment Profileget
mobile-device-extension-attributes-preview
- Get Mobile Device Extension Attribute values placed in select paramterget
mobile-device-groups
mobile-device-prestages
mobile-devices
parent-app-preview
patch-management
- Accept Patch Management disclaimerpost
patch-policies
patch-policy-logs
patch-software-title-configurations
policies-preview
re-enrollment-preview
remote-administration
- Get information about all remote administration configurations.get
scripts
self-service
- Get an object representation of Self Service settingsget
- Put an object representation of Self Service settingsput
self-service-branding-ios
self-service-branding-macos
self-service-branding-preview
- Upload an imagepost
sites
- Find all sitesget
sites-preview
- Find all sitesget
smart-computer-groups-preview
- Recalculate a smart group for the given idpost
- Recalculate the smart group for the given idpost
smart-mobile-device-groups-preview
- Recalculate all smart groups for the given device id and then return count of smart groups that device fall intopost
- Recalculate a smart group for the given id then return the ids for the devices in the smart grouppost
smart-user-groups-preview
- Recalculate the smart group for the given id and then return the ids for the users in the smart grouppost
- Recalculate a smart group for the given user id and then return the count of smart groups the user falls intopost
sso-certificate
sso-certificate-preview
sso-failover
- Retrieve the current failover settingsget
- Regenerates failover urlpost
sso-settings
startup-status
- Retrieve information about application startupget
static-user-groups-preview
- Return a list of all Static User Groupsget
- Return a specific Static User Group by idget
supervision-identities-preview
teacher-app
team-viewer-remote-administration
time-zones-preview
- Return information about the currently supported Time Zonesget
tomcat-settings-preview
- Generate a SSL Certificate using Jamf Certificate Authoritypost
user-session-preview
- Return all Jamf Pro user acountsget
- Update values in the User's current sessionpost
venafi-preview
volume-purchasing-locations
volume-purchasing-subscriptions
vpp-admin-accounts-preview
- Found all VPP Admin Accountsget
vpp-subscriptions-preview
- Found all VPP - subscriptionsget
- Found VPP subscription by idget

Classic API Introduction

Getting Started

Classic API

accounts
activationcode
- Finds the Jamf Pro activation codeget
- Updates the Jamf Pro activation codeput
advancedcomputersearches
advancedmobiledevicesearches
advancedusersearches
allowedfileextensions
buildings
byoprofiles
categories
classes
commandflush
- Flushes commands based on information specified in an XML filedelete
- Flushes commands for devicesdelete
computerapplications
computerapplicationusage
computercheckin
- Finds the Jamf Pro computer checkin informationget
- Updates the Jamf Pro computer checkin informationput
computercommands
computerextensionattributes
computergroups
computerhardwaresoftwarereports
computerhistory
computerinventorycollection
- Finds the Jamf Pro computer inventory collection informationget
- Updates the Jamf Pro computer inventory collection informationput
computerinvitations
computermanagement
computerreports
computers
departments
directorybindings
diskencryptionconfigurations
distributionpoints
dockitems
ebooks
fileuploads
- Creates file attachments in Jamf Propost
gsxconnection
- Finds the Jamf Pro GSX connection informationget
- Updates the Jamf Pro GSX connection informationput
healthcarelistener
healthcarelistenerrule
ibeacons
infrastructuremanager
jssuser
- Returns basic information about Jamf Pro, as well as privileges of the person requesting the resource. (Deprecated)get
jsonwebtokenconfigurations
ldapservers
licensedsoftware
logflush
macapplications
managedpreferenceprofiles
mobiledeviceapplications
mobiledevicecommands
mobiledeviceconfigurationprofiles
mobiledeviceenrollmentprofiles
mobiledeviceextensionattributes
mobiledevicegroups
mobiledevicehistory
mobiledeviceinvitations
mobiledeviceprovisioningprofiles
mobiledevices
networksegments
osxconfigurationprofiles
packages
patchavailabletitles
- Finds all available title from a source by IDget
patches
patchexternalsources
patchinternalsources
patchpolicies
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
peripherals
peripheraltypes
policies
printers
removablemacaddresses
restrictedsoftware
savedsearches
scripts
sites
smtpserver
- Finds the Jamf Pro SMTP server informationget
- Updates the Jamf Pro SMTP server informationput
softwareupdateservers
userextensionattributes
usergroups
users
vppaccounts
vppassignments
vppinvitations
webhooks

Jamf Pro API Introduction

Getting Started

Jamf Pro API

advanced-mobile-device-searches
advanced-user-content-searches
api-authentication
api-integrations
api-role-privileges
- Get the current Jamf API Role Privilegesget
- Search the current Jamf API Role Privilegesget
api-roles
app-request-preview
app-store-country-codes-preview
- Return a list of Countries and the associated Codesget
branding
- Download a self service branding imageget
buildings
cache-settings
- Get Cache Settingsget
- Update Cache Settingsput
categories
certificate-authority
classic-ldap
- Get mappings for OnPrem Ldap configuration with given id.get
client-check-in
cloud-azure
cloud-idp
cloud-information
- Retrieve information related to cloud setup.get
cloud-ldap
computer-groups
- Returns the list of all computer groupsget
computer-inventory
computer-inventory-collection-settings
computer-prestages
computers-preview
- Return a list of Computersget
conditional-access
- Get compliance information for a single computer deviceget
- Get compliance information for a single mobile deviceget
csa
dashboard
- Get all the dashboard setup informationget
departments
device-communication-settings
device-enrollments
device-enrollments-devices
- Retrieve a list of Devices assigned to the supplied idget
ebooks
engage
enrollment
enrollment-customization
enrollment-customization-preview
icon
inventory-information
- Get statistics about managed/unmanaged devices and computers in the inventoryget
inventory-preload
jamf-connect
jamf-management-framework
- Redeploy Jamf Management Frameworkpost
jamf-package
- Get the packages for a given Jamf applicationget
- Get the packages for a given Jamf applicationget
jamf-pro-information
- Get basic information about the Jamf Pro Serverget
- Get basic information about the Jamf Pro Serverget
jamf-pro-initialization
- Set up fresh installed Jamf Pro Serverpost
- Provide Database Password during startuppost
jamf-pro-initialization-preview
- Set up fresh installed Jamf Pro Serverpost
- Provide Database Password during startuppost
jamf-pro-notifications
- Get Notifications for user and siteget
- Delete Notificationsdelete
jamf-pro-notifications-preview
jamf-pro-server-url-preview
jamf-pro-user-account-settings
jamf-pro-user-account-settings-preview
jamf-pro-version
- Return information about the Jamf Pro including the current versionget
jamf-protect
ldap
local-admin-password
locales-preview
- Return locales that can be used in other featuresget
macos-managed-software-updates
- Retrieve available MacOs Managed Software Updatesget
- Send MacOs Managed Software Updatespost
managed-software-updates
mdm
mobile-device-apps
- Reinstall App Config for Managed iOS Appspost
mobile-device-enrollment-profile
- Retrieve the MDM Enrollment Profileget
mobile-device-extension-attributes-preview
- Get Mobile Device Extension Attribute values placed in select paramterget
mobile-device-groups
mobile-device-prestages
mobile-devices
parent-app-preview
patch-management
- Accept Patch Management disclaimerpost
patch-policies
patch-policy-logs
patch-software-title-configurations
policies-preview
re-enrollment-preview
remote-administration
- Get information about all remote administration configurations.get
scripts
self-service
- Get an object representation of Self Service settingsget
- Put an object representation of Self Service settingsput
self-service-branding-ios
self-service-branding-macos
self-service-branding-preview
- Upload an imagepost
sites
- Find all sitesget
sites-preview
- Find all sitesget
smart-computer-groups-preview
- Recalculate a smart group for the given idpost
- Recalculate the smart group for the given idpost
smart-mobile-device-groups-preview
- Recalculate all smart groups for the given device id and then return count of smart groups that device fall intopost
- Recalculate a smart group for the given id then return the ids for the devices in the smart grouppost
smart-user-groups-preview
- Recalculate the smart group for the given id and then return the ids for the users in the smart grouppost
- Recalculate a smart group for the given user id and then return the count of smart groups the user falls intopost
sso-certificate
sso-certificate-preview
sso-failover
- Retrieve the current failover settingsget
- Regenerates failover urlpost
sso-settings
startup-status
- Retrieve information about application startupget
static-user-groups-preview
- Return a list of all Static User Groupsget
- Return a specific Static User Group by idget
supervision-identities-preview
teacher-app
team-viewer-remote-administration
time-zones-preview
- Return information about the currently supported Time Zonesget
tomcat-settings-preview
- Generate a SSL Certificate using Jamf Certificate Authoritypost
user-session-preview
- Return all Jamf Pro user acountsget
- Update values in the User's current sessionpost
venafi-preview
volume-purchasing-locations
volume-purchasing-subscriptions
vpp-admin-accounts-preview
- Found all VPP Admin Accountsget
vpp-subscriptions-preview
- Found all VPP - subscriptionsget
- Found VPP subscription by idget

computerhistory

This resource corresponds with the Computer History Information feature. Some of the data points described within the referenced article are accessible via other endpoints.

Copyright Privacy Terms of Use Trust Modern Slavery Act Statement

All contents © copyright 2002-2024 Jamf. All rights reserved.