Platform API Gateway Introduction

Getting started
Platform API fundamentals
Permissions map
Move an existing integration to the Platform API Gateway

AI GOVERNANCE POLICIES - PREVIEW

policies
tools

Audit

audit

Blueprints

blueprints

Compliance Benchmarks

benchmarks
rules
- Returns list of rules for specific baselineget
baselines
- Returns list of the mSCP baselinesget
benchmark-reports

Declaration Reporting

device-reports
- Get filtered device report declarationsget
- Get device channelsget
declaration-reports
- Get filtered declaration report devicesget

Device Inventory

devices
users
- Get devices for a userget

Device Groups

device-groups
devices
- Get device groups for a deviceget

Device Management Actions

device-actions

Security Cloud Devices

device-groups

SECURITY CLOUD Categories

categories
- List Categoriesget

Security Cloud DNS

zones
search-domains
custom-hostname-mappings

Security Cloud Enrollment

activation-profiles

UEM Connect

connectors
connector-enablement
- Enable connector synchronizationput
- Disable connector synchronizationdel
sync-configuration
- Get connector sync settingsget
- Update connector sync settingsput
sync-execution
activation-profiles
- Deploy Jamf Security configuration profiles to UEMpost

ZTNA

gateways
shared-gateways
- List Shared Gatewaysget
grouped-gateways
apps
predefined-apps
- List Predefined Appsget

Jamf Account Partners

deal-registrations
- List Deal Registrationsget
distributor-quotes
- Get Distributor Quoteget
distributor-purchase-orders
distributor-configuration
- Get Distributor Configurationget
- Update Distributor Configurationpatch

Jamf Account Licensing

licenses
- List Licensesget

Jamf Account

domains
connections

Jamf Protect

Jamf Protect

Jamf Pro

computer-inventory
account-groups
- Get account groupsget
- Gets the account group. get
accounts
activation-code
adcs-settings
advanced-mobile-device-searches
advanced-user-content-searches
apns-client-push-status
app-installers
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
device-communication-settings
device-enrollments
device-enrollments-devices
- Retrieve a list of Devices assigned to the supplied id get
devices
- Return a list of groups for a device get
digicert
distribution-point
dock-items
ebooks
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
- Get Jamf Pro account preferences get
- Update Jamf Pro account preferences patch
jamf-pro-information
- Get basic information about the Jamf Pro Server get
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
last-login
- Get the date of the last login eventget
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
m2m
- Returns the M2M-sourced tenant ID.get
macos-managed-software-updates
- Send MacOs Managed Software Updatespost
managed-software-updates
mdm
mdm-renewal
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
- Get Policy Properties object get
- Update Policy Properties object put
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
service-discovery-enrollment
- Get service discovery well-known settings for all organizationsget
- Update service discovery well-known settingsput
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-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
user-sessions
- Get active user sessions. get
- Get count of active user sessions. get
users
venafi-preview
volume-purchasing-locations
volume-purchasing-subscriptions

JAMF PRO Classic

patchsoftwaretitles
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
patchpolicies
- Finds all patch policies. (Deprecated). Please transition use to Jamf Pro API endpoint "/v2/patch-policies".get
- Finds all patch policies by patch software title configuration ID (Deprecated). Please transition use to Jamf Pro API endpoint "/v2/patch-policies".get
patches
activationcode
- Finds the Jamf Pro activation codeget
- Updates the Jamf Pro activation codeput
advancedcomputersearches
advancedmobiledevicesearches
advancedusersearches
allowedfileextensions
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
directorybindings
diskencryptionconfigurations
distributionpoints
dockitems
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
patchavailabletitles
- Finds all available title from a source by IDget
patches
- Finds the first patch with the name provided (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".)get
patchexternalsources
patchinternalsources
patchpolicies
printers
removablemacaddresses
restrictedsoftware
savedsearches
smtpserver
- Finds the Jamf Pro SMTP server informationget
- Updates the Jamf Pro SMTP server informationput
softwareupdateservers
userextensionattributes
usergroups
vppaccounts
vppassignments
vppinvitations
webhooks
accounts
buildings
categories
departments
ebooks
packages
policies
scripts
sites
users

Force a device DDM sync

post

https://{region}.api.jamfcloud.com/pro/v1/ddm/{clientManagementId}/sync

Force a device to sync by queuing a new DeclarativeManagementCommand

Required Permissions: device-actions:execute

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientManagementId

string

required

The client management id of the target device.

Headers

X-Tenant-Id

uuid

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The tenant UUID identifier. Send it to address tenant scope. This API is also published at environment scope — send that scope's header instead. Send exactly one scope header per request.

X-Environment-Id

uuid

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The environment UUID identifier. Send it to address environment scope. This API is also published at tenant scope — send that scope's header instead. Send exactly one scope header per request.

Responses

204

The device was successfully synced.

403

Insufficient privileges to perform this action.

Updated 15 days ago

Retrieve a Status Item from the latest Status Report for a device

Retrieve an existing declaration

Did this page help you?

Language

Credentials

OAuth2

Bearer

URL

Loading…

Response

Choose an example:

application/json

Updated 15 days ago

Retrieve a Status Item from the latest Status Report for a device

Retrieve an existing declaration

Did this page help you?

500Failure, unable to complete sync request.