Jump to Content

Guides Recipes API Reference Changelog

API Reference

Guides Recipes API Reference Changelog

All

Pages

Start typing to search…

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 filedel
- Flushes commands for devicesdel
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
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

accounts
activation-code
adcs-settings
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 Codes get
branding
- Download a self service branding image get
buildings
cache-settings
- Get Cache Settings get
- Update Cache Settings put
categories
certificate-authority
classic-ldap
- Get mappings for OnPrem Ldap configuration with given id.get
client-check-in
cloud-azure
cloud-distribution-point
cloud-idp
cloud-information
- Retrieve information related to cloud setup. get
cloud-ldap
computer-extension-attributes
computer-groups
computer-inventory
computer-inventory-collection-settings
computer-prestages
computers-preview
- Return a list of Computers get
conditional-access
csa
dashboard
- Get all the dashboard setup information get
- Add or remove an object to the Jamf Pro dashboard post
declarative-device-management
departments
devices
- Return a list of groups for a device get
device-communication-settings
device-enrollments
device-enrollments-devices
- Retrieve a list of Devices assigned to the supplied id get
digicert
distribution-point
dock-items
ebooks
engage
enrollment
enrollment-customization
enrollment-customization-preview
groups
gsx-connection
health-check
- Get Jamf Pro API statusget
- Retrieve request acceptance ratios for this Jamf Pro nodeget
icon
impact-alert-notification-settings
- Get Impact Alert Notification Settingsget
- Update Impact Alert Notification Settingsput
inventory-information
- Get statistics about managed/unmanaged devices and computers in the inventory get
inventory-preload
jamf-cloud-distribution-service
jamf-connect
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
jamf-pro-information
- 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 del
jamf-pro-server-url-preview
jamf-pro-user-account-settings
jamf-pro-version
- Return information about the Jamf Pro including the current version get
jamf-protect
jamf-remote-assist
ldap
local-admin-password
locales-preview
- Return locales that can be used in other features get
log-flushing
login-customization
- Get current login disclaimer settingsget
- Update current login disclaimer settings.put
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 Apps post
mobile-device-enrollment-profile
- Retrieve the MDM Enrollment Profile get
mobile-device-extension-attributes
mobile-device-extension-attributes-preview
- Get Mobile Device Extension Attribute values placed in select paramter get
mobile-device-groups
mobile-device-prestages
mobile-devices
oidc
onboarding
packages
parent-app-preview
patch-management
- Accept Patch Management disclaimer post
patch-policies
patch-policy-logs
patch-software-title-configurations
policies-preview
re-enrollment-preview
remote-administration
- Get information about all remote administration configurations.get
return-to-service
scheduler
scripts
self-service
self-service-branding-ios
self-service-branding-macos
self-service-branding-preview
- Upload an image post
self-service-plus
sites
- Find all sites get
- Find and filter site objects for a site ID get
slasa
- Get the status of SLASAget
- Accept the SLASApost
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
sso-certificate
sso-failover
- Retrieve the current failover settingsget
- Regenerates failover urlpost
sso-oauth-session-tokens
- Retrieve the access token and user information for the current session. get
sso-settings
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
teacher-app
team-viewer-remote-administration
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
volume-purchasing-locations
volume-purchasing-subscriptions

Title Editor

auth
capabilities
- Update capabilityput
- Delete capabilitydel
codesigning
components
criteria
- Update criteriaput
- Delete criteriadel
extensionattributes
externaltitles
killapps
overrides
patches
preferences
privileges
- Delete privilegedel
requirements
- Update requirementput
- Delete requirementdel
smtpserver
softwaretitles
sources
users
valuelists

Powered by

Retrieve a full dockItem object

get https://yourServer.jamfcloud.com/api/v1/dock-items/{id}

Retrieves a full dockItem object

Language

Credentials

Log in to use your API keys

Jamf helps organizations succeed with Apple. By enabling IT to empower end users, we bring the legendary Apple experience to businesses, education and government organizations.

Quick Links

Jamf Support
Training & Certifications
Jamf Nation Community
Jamf Blog
Marketplace
Become a Partner
Find a Partner
Jamf Account

Solutions

The Jamf platform
Zero-touch deployment
Mobile Device Management (MDM)
Application management
Inventory management

Identity and access management
Endpoint protection
Threat prevention and remediation
Content filtering and safe internet

Copyright Privacy Terms of Use Trust Modern Slavery Act Statement

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