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

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-distribution-point
- Finds specific information for the currently configured Cloud Distribution Point.get
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
csa
- Get details regarding the CSA token exchangeget
- Delete the CSA token exchange - This will disable Jamf Pro's ability to authenticate with cloud-hosted servicesdel
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
dock-items
ebooks
engage
enrollment
enrollment-customization
enrollment-customization-preview
health-check
- Get Jamf Pro API statusget
icon
inventory-information
- Get statistics about managed/unmanaged devices and computers in the inventoryget
inventory-preload
jamf-connect
jamf-content-distribution-server
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-account-preferences
- Get Jamf Pro account preferencesget
- Update Jamf Pro account preferencespatch
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-notifications
- Get Notifications for user and siteget
- Delete Notificationsdel
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
jamf-remote-assist
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
onboarding
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
return-to-service
scheduler
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
- Find and filter site objects for a site IDget
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
smtp-server
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
- Changes the user account password.post
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

Powered by

Retrieve the current failover settings

get

https://yourServer.jamfcloud.com/api/v1/sso/failover

Retrieve the current failover settings

Language

Credentials

Bearer

JWT

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.