Table of Contents
- Why Use Jamf Device Checker?
- Quick Start
- Full Setup Instructions
- Configuration Reference
- Required Keys
- Branding & Alerts URL
- Share Buttons
- Links
- UI Behavior
- Operating System Readiness
- App Readiness
- Power Source (Battery Level)
- Storage Capacity
- Battery Health
- Battery Level Requirement
- Device Health
- Configuration Profiles
- Certificates
- Thermal State
- Performance (Memory & CPU)
- Network Status
- Jamf Setup Extension Attribute (Setup Status & Off Duty)
- Auto-Refresh Throttling
- Configuration Examples
- Legal
Why Use Jamf Device Checker?
The Problem
End users often experience device issues that impact their productivity but don't know how to identify or resolve them:
- Missing or outdated apps versions
- Outdated iOS versions
- Low battery health causing unexpected shutdowns
- Storage capacity issues preventing app installations
- Network connectivity problems affecting productivity
- Device overheating causing performance throttling
- High memory/CPU usage slowing down work
These issues typically result in help desk tickets, lost productivity, and frustrated users.
The Solution
Jamf Device Checker empowers end users to self-diagnose and resolve device readiness issues through a simple, color-coded interface:
- โ Green = Device is ready for work
- ๐ Orange = Warnings that should be addressed soon
- ๐ด Red = Critical issues preventing productivity
Key Benefits
For End Users: self-service device readiness checks, clear actionable guidance for fixing issues, reduced wait time for IT support, and proactive notifications before deadlines.
For IT Teams: reduced help desk tickets, readiness enforcement of corporate policies (OS versions, required apps), real-time visibility into device health, and configurable thresholds and monitoring rules.
For Organizations: improved end-user productivity, better device lifecycle management, reduced IT support costs, and readiness tracking and reporting.
Overall Status Display
The app displays a large, color-coded status indicator at the top of the main screen that summarizes the device's overall readiness.
| Status | Color | Icon | Description |
|---|---|---|---|
| Ready | ๐ข Green | Checkmark | All enabled checks pass. Shows "Your device meets all requirements". |
| Deadline Approaching | ๐ Orange | Warning triangle | Updates available, and at least one item that still needs updating has a deadline that hasn't been reached. Shows "X update(s) available - Y day(s) remain" with countdown to the earliest outstanding deadline. A deadline that can't be read as yyyy-MM-dd shows "X update(s) needed before deadline". |
| Action Needed | ๐ Orange | Warning triangle | Updates available, but none of the items that still need updating has a deadline (deadlines on items that are already ready are ignored). Shows "X update(s) available". |
| Not Ready | ๐ด Red | X mark | An outstanding update has reached its deadline (the deadline day itself counts as past), the battery is below the configured minimum level, or the OS is newer than the exact approved version. Shows "X update(s) required", "OS newer than approved version" and/or "Charge battery to at least X%", joined with " ยท ". |
| Installing Updates | ๐ต Blue | Spinning arrows | App updates requested from the Apps row. Shows "This usually takes a few minutes" and an "Estimated time remaining" countdown of 2 minutes until the next automatic check. |
| Off Duty | โช Gray | Moon with Z's (moon.zzz) |
Jamf Setup EA value matches the configured off-duty value. The title shows that value. See Jamf Setup Extension Attribute. |
| Unknown | โช Gray | Question mark | Initial state before first check completes, or the Jamf Setup EA value matches neither the on-duty nor the off-duty value. Shows "Waiting for status check". If the first check fails, the status stays Unknown and shows the reason followed by "Tap Refresh to try again." |
Deadlines use the yyyy-MM-dd format and are parsed with a fixed Gregorian calendar and POSIX locale, so they behave the same regardless of the device's region, calendar or 12/24-hour settings. Days are counted from the start of the day in the device's time zone. The deadline day itself counts as past: a deadline of 2026-06-30 makes the item Not Ready from June 30.
When Jamf Pro can't be reached: the app keeps showing the last known status, with a banner reading "<reason> โ showing last known status" and a "Last successful check" line under the status. If the connection is lost while Installing Updates, the banner reads "Unable to verify update status โ showing last known status". Installing Updates doesn't survive a relaunch: the app returns to the status it had before the update, or to Unknown.
App Layout
The tab bar adapts to the device:
- iPhone: Refresh | Status | Alerts* | Links* | More. Tapping Refresh runs a check and returns to Status. More opens as a sheet with a Done button.
- iPad: Status | Alerts* | Links* | More, plus a floating refresh button at the bottom right of the Status tab.
*Alerts appears only when device-checker-alerts-url is a valid https:// URL, and Links only when links are enabled and at least one valid link is configured.
The layout follows the horizontal size class, so an iPad in a narrow Split View or Slide Over window uses the iPhone layout.
On the Status tab, the Requirements section holds Apps, Operating System and (when a minimum level is set) Battery. The Device Status section holds the informational tiles.
Quick Start
Prerequisites
- Jamf Pro server (JPS)
- Admin access to Jamf Pro
- iPhone or iPad running iOS/iPadOS 18.6 or later (the app is not available on Mac)
- Jamf Self Service app (optional; only needed for the Update button on the Apps row)
- Local user account with the wizard privileges listed under Required API Privileges (13 privileges: the 8 wizard privileges plus the 5 runtime privileges)
Required API Privileges
The app uses two distinct sets of privileges:
For Wizard Setup (local user account, used during initial configuration):
Create a local user in Jamf Pro with these 13 privileges:
- Read Mobile Device Applications
- Update Mobile Device Applications
- Read API Integrations
- Create API Integrations
- Update API Integrations
- Read API Roles
- Create API Roles
- Update API Roles
- Send Device Information Command
- View MDM command information in Jamf Pro API
- Read Mobile Devices
- Send MDM command information in Jamf Pro API
- Update Mobile Devices
The last 5 are the runtime privileges listed below. Jamf Pro only lets a user create or update an API role with privileges the user holds, so the wizard user needs them too.
This user account authenticates the wizard via Basic Auth to create the API integration, configure roles, link the native app, and save app config XML. Each time the wizard opens it reads app records, API integrations and API roles, so those read privileges are needed whenever the wizard or App Config Builder is used. Creating the integration is a one-time step.
For Runtime Operation (OAuth API client, automatically configured by wizard):
The wizard automatically creates a "Jamf Device Checker" API role with these 5 privileges assigned to the linked app integration:
- Send Device Information Command
- View MDM command information in Jamf Pro API
- Read Mobile Devices
- Send MDM command information in Jamf Pro API
- Update Mobile Devices
These privileges allow the device checker to fetch device details, send MDM commands and (when the user toggle is enabled) update the Jamf Setup EA during normal operation using OAuth authentication. End users never see or use these credentials.
5-Minute Setup
Step 1: Purchase and add the app to Jamf Pro
- Purchase "Jamf Device Checker" and assign to Jamf Pro instance in AxM
- Navigate to Mobile Device Apps in Jamf Pro
- Add "Jamf Device Checker" from Apps Purchased in Volume
Step 2: Run the Setup Wizard
- Install the app on your admin device
- Launch the app and open the wizard (see Enable Wizard Mode)
- Authenticate with local user (requires the 13 wizard user privileges; see Required API Privileges above)
- On the Linked App Wizard tab, the "Jamf Device Checker" API role is created or updated automatically
- Tap Remediate to create the API integration and link the app to it for authentication
- Open the App Config Builder, pick the app record and tap Save to Jamf to save the managed app config
There is no step 3: just scope to end-user devices.
Full Setup Instructions
Step 1: Add Mobile Device App to Jamf Pro
- Purchase "Jamf Device Checker" and assign to Jamf Pro instance in AxM
- Log into Jamf Pro
- Navigate to Devices > Mobile Device Apps
- Click + New
- Search for "Jamf Device Checker" in Apps Purchased in Volume
- Click Add to add the app record to your Jamf Pro instance
Step 2: Run the Setup Wizard
The wizard handles all the authentication and managed app configuration automatically.
Install App on Admin Device
- Assign the app to a test iOS device
- Launch Jamf Device Checker
Enable Wizard Mode
There are three ways into the wizard:
- No app config yet: the app opens to a login screen. Enter the Jamf Pro server URL (must start with
https://), the local user name and the password, and the wizard starts on the Linked App Wizard tab. The server URL is only asked for here: once an app config suppliesJPS_URL, the field is prefilled with it. - Status tab: long-press the overall status area (standard long-press) to open the wizard login. With VoiceOver, use the Open setup wizard action on the status area.
- More tab: long-press the app icon (standard long-press) to reveal a Wizard Setup row, then select it. With VoiceOver, use the Show advanced options action on the app title.
Authenticate with the local user credentials created in Prerequisites (Basic Auth, requires the 13 wizard user privileges). The long-press entry points open the wizard on its second tab, which is the App Config Builder once setup is complete. The long-press entry points are disabled in App Store Review Mode.
Complete Wizard Steps
API Role
- When the Linked App Wizard tab loads, it checks for an existing "Jamf Device Checker" API role
- If not found, creates the role with required privileges (an existing role missing any of them is updated):
- Send Device Information Command
- View MDM command information in Jamf Pro API
- Read Mobile Devices
- Send MDM command information in Jamf Pro API
- Update Mobile Devices
Remediate (API Integration and Native App Authentication)
- Remediate appears when an app record still needs to be linked. Tap it to create the API integration with the "Jamf Device Checker" role and link the Jamf Device Checker app records to it (an existing integration with the wrong role gets the role added)
- Jamf Pro then supplies
OAUTH_AUTH_CODEto the app through the Managed App Config - When everything is configured, an App Config button appears that switches to the App Config Builder
Generate App Config
- Open the App Config Builder (available once setup is complete), pick the app record and tap Save to Jamf
- The builder generates the Managed App Config and sends it to Jamf Pro
Step 3: Scope to Devices
- In the same app record, click Scope
- Add target device groups, smart groups, or individual devices
- Click Save
App Config Builder
The wizard includes an App Config Builder for editing the managed app config of an app record and saving it back to Jamf Pro. Loading a record always starts from defaults, so values from a previously loaded record never carry over to the next one.
The UI Behavior section sets the scrollable Status tab and the Spinner Style (Default or Aviation). See UI Behavior.
Working with records: Save to Jamf also stays disabled until an app record is chosen. The record picker opens the first time the builder appears, and the Select Record button reopens it. The picker marks the record for the current device with a CURRENT DEVICE badge and shows "No App Records Found" when there are none. The builder can also show a preview of the generated XML. After a successful save, a Save Result alert appears, the wizard and More sheets close, and the Status tab refreshes.
What the builder writes: every on/off key (device-checker-*-enabled) is written, as NO when its section is off โ except device-checker-links-enabled and device-checker-jamf-setup-ea-toggle-enabled, which belong to the Links and Jamf Setup EA sections and are left out entirely (not written as NO) when those sections are off. For a section that is off, the builder also leaves out the other keys that belong to it, so the app falls back to its defaults for them:
- Branding, alerts and links are left out completely (an empty alerts URL is left out too).
- OS minimum version, exact-version and deadline; power source, storage, memory and CPU thresholds; the battery minimum level (also left out when set to 0); the Jamf Setup EA name, values and toggle; and the connectivity test endpoint, timeout and cache TTL.
- The apps list and
device-checker-apps-exact-versionare written only when app monitoring is on and the list has at least one app.
Values you set by hand in a section that you switch off in the builder are therefore lost the next time you save. device-checker-auto-refresh-threshold is always written but has no control in the builder. The battery minimum level is offered in steps of 5%.
The builder validates the config before saving. Problems are listed under Fix before saving, and Save to Jamf stays disabled until they are fixed:
- Apps (when app monitoring is enabled): name, bundle ID and minimum version are required for each app. Name, bundle ID and minimum version can't contain
,or|; Notes can contain commas but not|. Minimum versions must be digits separated by dots (e.g.2.5.0). - Thresholds (each rule applies only while its section is enabled): warning levels must be below critical levels for storage, memory and CPU. For power source, the critical level must be below the warning level. Equal values are rejected in every case.
- URLs (each checked only while its section is enabled): the branding image URL, alerts URL and connectivity test endpoint must start with
https://and include a host name. The branding image may instead be the built-in namejamf, and the alerts URL may be left empty.
The builder doesn't check the link scheme. A link whose URL doesn't start with http:// or https:// is saved but ignored by the app, so use https:// links. See Links.
Configuration Reference
The app is configured entirely through Jamf Pro's Managed App Config. Below is a complete reference of all available keys. Boolean keys are on only when set to YES (case-insensitive); any other value means NO. Threshold values (storage, power, memory, CPU) aren't cross-checked on the device, so a warning level that isn't below its critical level isn't caught there; the App Config Builder rejects it before saving.
Required Keys
These keys are automatically populated by Jamf Pro. Do not modify or remove them.
| Key | Description |
|---|---|
JPS_URL |
Jamf Pro server URL (auto-populated: $JPS_URL) |
JSSID |
Device JSS ID (auto-populated: $JSSID) |
MANAGEMENTID |
Device Management ID (auto-populated: $MANAGEMENTID) |
OAUTH_AUTH_CODE |
OAuth authorization code (auto-populated: $OAUTH_AUTH_CODE) |
APP_CONFIG_REINSTALL_CODE |
Reinstall trigger code (auto-populated: $APP_CONFIG_REINSTALL_CODE) |
APPJSSID |
Jamf Device Checker app record ID (auto-populated: $APPJSSID) |
Branding & Alerts URL
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-branding-image-url |
String | (empty) | URL to company logo image (PNG/JPG), or jamf for the built-in Jamf logo. Any other value is loaded as a URL. Leave blank for no branding. |
device-checker-branding-image-height |
Integer | 80 |
Logo height in points. Use a whole number: the App Config Builder drops a decimal value when it loads the config. |
device-checker-alerts-url |
String | (empty) | Optional https:// URL for an alerts/status page. When set, an Alerts tab shows the page in an in-app web view. If the value is empty or not a valid https:// URL, the Alerts tab is not shown. |
Example:
<key>device-checker-branding-image-url</key>
<string>https://yourcompany.com/logo.png</string>
<key>device-checker-branding-image-height</key>
<string>60</string>
Share Buttons
Control visibility of status sharing and log export features in the More tab.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-send-status-enabled |
String | YES |
Show "Send Status" button (shares device readiness summary via email/messages) |
device-checker-send-logs-enabled |
String | YES |
Show "Send Logs" button (exports app logs for troubleshooting) |
device-checker-clear-logs-enabled |
String | NO |
Show the trash button on the Logs screen so users can delete all log entries (asks for confirmation first) |
device-checker-ai-summary-enabled |
String | NO |
Show a "What should I do?" card on the Status tab when the device is Not Ready. The card always lists the steps to take; on a device with Apple Intelligence (iOS 26+) those steps are also reworded in plainer language, on the device, and nothing is sent anywhere. Readiness is never decided by it. While Not Ready the card replaces the update summary line under the status. The same key adds a short "What this means" explanation to the detail screens of the OS, Apps, Battery, Certificates and Configuration Profiles tiles; those appear only on devices with Apple Intelligence. Neither is shown in App Store Review Mode |
Example:
<key>device-checker-send-status-enabled</key>
<string>YES</string>
<key>device-checker-send-logs-enabled</key>
<string>NO</string>
<key>device-checker-clear-logs-enabled</key>
<string>NO</string>
Links
Add bookmark-style links to enterprise resources as a dedicated tab. Links open in the device's default browser (Safari).
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-links-enabled |
String | NO |
Enable the Links tab |
device-checker-links-list |
String | (empty) | JSON array of link objects (see format below) |
Link List Format:
[{"title":"Support Portal","url":"https://support.company.com"},{"title":"IT Knowledge Base","url":"https://kb.company.com"}]
Example:
<key>device-checker-links-enabled</key>
<string>YES</string>
<key>device-checker-links-list</key>
<string>[{"title":"Support Portal","url":"https://support.company.com"},{"title":"IT Knowledge Base","url":"https://kb.company.com"}]</string>
Tab Behavior:
The Links tab appears conditionally in the tab bar only when both conditions are met: links are enabled (YES) AND at least one valid link is configured. See App Layout for tab ordering.
Notes:
- Each link requires a
title(non-empty) and aurl(must usehttp://orhttps://scheme) - Invalid links (empty title or malformed URL) are silently filtered out
- Links are parsed when the app config loads, so the Links tab works offline and in App Store Review Mode
- Links open in Safari (external browser), not an in-app web view
UI Behavior
Control the scrolling behavior and visual style of the Status tab.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-status-tab-scrollable |
String | NO |
When YES, makes the entire Status tab scrollable (header + overall status + tiles). When NO (default), the header and overall status remain fixed with only the tiles scrolling below. The whole tab also scrolls at accessibility text sizes and in iPhone landscape, whatever this key says. |
device-checker-spinner-style |
String | default |
Loading spinner animation style: default (native iOS spinner) or aviation (custom turbine animation) |
Example:
<key>device-checker-status-tab-scrollable</key>
<string>NO</string>
<key>device-checker-spinner-style</key>
<string>default</string>
When to enable: The default (NO) is best for most deployments: the header and overall readiness status remain visible while scrolling through tiles. Set to YES when you need the entire view to scroll together, or to accommodate longer branding headers on smaller devices.
Spinner Style: The default style uses the native iOS activity indicator. The aviation style uses a custom rotating turbine animation. The spinner appears in the "Checking status..." overlay while a check is running. Values are case-insensitive, and a missing or unknown value falls back to default. You can also set the style in the App Config Builder under UI Behavior. The aviation style also words the "newer than approved" OS message for an aviation audience, telling the user to contact the EFB Team.
Operating System Readiness
Monitor OS version requirement with configurable minimum version and deadline.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-os-enabled |
String | YES |
Enable OS version monitoring tile |
device-checker-os-min-version |
String | (none) | Minimum required OS version (e.g., 26.2), or the exact approved version when exact matching is on |
device-checker-os-exact-version |
String | NO |
YES requires the device to run exactly device-checker-os-min-version. Missing parts count as 0, so 26.2 matches only 26.2 / 26.2.0 |
device-checker-os-deadline |
String | (none) | Requirement deadline in yyyy-MM-dd format |
Example:
<key>device-checker-os-enabled</key>
<string>YES</string>
<key>device-checker-os-min-version</key>
<string>26.2</string>
<key>device-checker-os-deadline</key>
<string>2026-06-30</string>
Status Logic:
โ Green (Ready): Current OS version meets minimum requirement
๐ Orange (Warning): Current OS version below minimum, but deadline has NOT been reached (or no deadline configured)
๐ด Red (Not Ready): Current OS version below minimum AND deadline has been reached (the deadline day itself counts as past)
When the OS is below the minimum, the row shows an Update button that opens the Settings app so the user can install the update.
Exact version matching: With device-checker-os-exact-version set to YES, a device on an older version follows the rules above. A device on a newer version than the approved one is ๐ด Red (Not Ready) right away, whatever the deadline, because iOS and iPadOS can't be downgraded. The row reads "newer than approved", there is no Update button, and the user is asked to contact IT.
App Readiness
Monitor installation status and version requirements for required managed apps.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-apps-enabled |
String | NO |
Enable app monitoring tile |
device-checker-apps-list |
String | (empty) | Pipe-separated list of apps (see format below) |
device-checker-apps-exact-version |
String | NO |
YES makes each app's version the exact approved version, for every app in the list. Missing parts count as 0, so 5.0 matches only 5.0 / 5.0.0 |
App List Format:
AppName,bundleID,minVersion,deadline[,Notes]|AppName2,bundleID2,minVersion2,deadline2[,Notes2]|...
Square brackets mark an optional part. Leave out ,Notes entirely, or add a comma and your note. Don't type the brackets themselves.
Example:
<key>device-checker-apps-enabled</key>
<string>YES</string>
<key>device-checker-apps-list</key>
<string>Slack,com.tinyspeck.chatlyio,24.0.0,2026-03-01,Update from Self Service|Microsoft Teams,com.microsoft.skype.teams,5.0.0,2026-06-01</string>
Status Logic:
โ Green (Ready): All apps installed and meet minimum versions
๐ Orange (Warning): One or more apps need updating, but deadline has NOT been reached
๐ด Red (Not Ready): One or more apps need updating AND deadline has been reached (the deadline day itself counts as past)
โณ Installing Updates (overall status only): After the user taps Update and Self Service opens, the overall status changes to Installing Updates (blue). The Apps row keeps its orange or red status until a check shows the apps are ready (see Self Service integration below)
Exact version matching: With device-checker-apps-exact-version set to YES, an app on a newer version than the listed one needs updating, just like an older one. It follows the app's deadline, stays in the Self Service Update list, and the app's detail view labels the version "Approved Version" instead of "Required". The Apps row still reads "N apps need updating".
Self Service Integration:
When apps are missing or outdated, users can tap the "Update" button on the Apps row to automatically install or update required apps. The workflow is:
- User taps the "Update" button on the Apps row
- Jamf Self Service opens automatically with missing/outdated apps queued. If Self Service isn't installed or can't be opened, nothing happens and the status doesn't change
- Once Self Service has opened, the overall status changes to Installing Updates and a 2-minute countdown starts
- When the countdown ends, the app refreshes. While apps are still not ready and Jamf Pro is reachable, it stays in Installing Updates and restarts the countdown
- Once all apps meet requirements, the overall status updates to Ready (or whatever the other checks report). If Jamf Pro can't be reached, the app returns to its previous status and shows a "showing last known status" banner
Requirements: Jamf Self Service must be installed on the device, apps must be available in Self Service and scoped to the device, and apps must have "Display app in Self Service after it is installed" checked in Jamf Pro.
Notes:
- Bundle ID must match exactly (case-sensitive)
- Version comparison checks every numeric component in order (e.g.,
2.5.0>2.4.9,1.2.3.4>1.2.3). Missing components count as 0, and only the leading digits of each component are used, so1.2b.3is treated as1.2.3 - Spaces around fields are trimmed. Entries with fewer than four fields or an empty bundle ID are skipped
- If an installed app reports no version, its version shows as "unknown" and it counts as needing an update
- The app detail view also shows the deadline with a timeline for apps that need updating, and the expiry of the app's provisioning profile (with a warning within 30 days)
- Deadline is optional (leave blank if not needed:
AppName,bundleID,minVersion,) and usesyyyy-MM-ddformat - Notes is an optional fifth field shown as a row in the app's detail view. It's everything after the deadline, so it may contain commas (e.g.
AppName,bundleID,minVersion,deadline,Install from Self Service, then restart), but it must not contain the|character, which separates apps
Power Source (Battery Level)
Monitor battery charge level with configurable warning and critical thresholds.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-power-source-enabled |
String | YES |
Enable battery level monitoring tile |
device-checker-power-source-warning |
Integer | 25 |
Warning threshold (percentage) |
device-checker-power-source-critical |
Integer | 10 |
Critical threshold (percentage) |
Example:
<key>device-checker-power-source-enabled</key>
<string>YES</string>
<key>device-checker-power-source-warning</key>
<string>25</string>
<key>device-checker-power-source-critical</key>
<string>10</string>
Status Logic:
๐ด Red (Critical): Battery < critical threshold
๐ Orange (Warning): Battery < warning threshold (but โฅ critical)
โ Green (Ready): Battery โฅ warning threshold
โก Charging: Device is plugged in (always green when charging). A fully charged device still plugged in counts as plugged in.
๐ด Red (No battery information): The battery level can't be read and the device isn't plugged in.
Power Source is informational only and does not affect the overall status.
Storage Capacity
Monitor available storage with configurable warning and critical thresholds (based on percentage used).
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-storage-enabled |
String | YES |
Enable storage monitoring tile |
device-checker-storage-warning |
Integer | 75 |
Warning threshold (% used) |
device-checker-storage-critical |
Integer | 90 |
Critical threshold (% used) |
Example:
<key>device-checker-storage-enabled</key>
<string>YES</string>
<key>device-checker-storage-warning</key>
<string>75</string>
<key>device-checker-storage-critical</key>
<string>90</string>
Status Logic:
๐ด Red (Critical): Storage used โฅ critical threshold
๐ Orange (Warning): Storage used โฅ warning threshold (but < critical)
โ Green (Ready): Storage used < warning threshold
Battery Health
Monitor battery health status to identify devices that may need battery replacement. This tile displays battery health status and current charge percentage.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-battery-enabled |
String | YES |
Enable battery health monitoring tile. To also require a minimum charge, see Battery Level Requirement |
Example:
<key>device-checker-battery-enabled</key>
<string>YES</string>
Status Logic:
โ Green (Ready): Battery health is "Normal" or "Unsupported", or any other value that isn't listed below
๐ด Red (Not Ready): Battery health is "Service-Recommended" or "Non-Genuine"
โช Gray (Unknown): Battery health is "Unknown", empty, or unable to retrieve battery data
Health Status Values:
- Normal: Battery is functioning properly (Green)
- Service-Recommended: Battery capacity has degraded, replacement recommended (Red)
- Non-Genuine: Non-Apple battery detected, replacement recommended (Red)
- Unsupported: Battery health monitoring not available on this device model (Green, shows charge % only)
- Unknown: Health data not yet available from iOS (Gray, shows charge % only)
Tile Display: The status color and icon are based on battery health, unless a minimum charge level is set and not met. In that case the row is red and the subtitle reads "N% charged ยท M% required". Otherwise the subtitle shows the battery health issue if present, or the current charge percentage. The detail view shows charge level, required level (if set), charging state, Low Power Mode, battery health status, and recommendations.
Notes:
- Battery health data comes from Declarative Device Management (DDM)
- New devices may show "Unknown" until iOS calculates health metrics (typically after a few charge cycles)
- Charge percentage is always displayed in the subtitle or detail view
- This tile focuses on battery health; use the Power Source tile for charge level monitoring with thresholds, or the Battery Level Requirement to make a minimum charge part of readiness
Battery Level Requirement
Make a minimum battery charge part of device readiness, alongside OS version and apps.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-battery-min-level |
String | (none) | Minimum charge % (1โ100) required for Ready. Requires device-checker-battery-enabled to be YES |
Example:
<key>device-checker-battery-enabled</key>
<string>YES</string>
<key>device-checker-battery-min-level</key>
<string>50</string>
Behavior:
- When set, the Battery row moves from Device Status to the Requirements section.
- Charge below the minimum shows the Battery row in red and the overall status as Not Ready, with "Charge battery to at least X%". There is no deadline.
- Only the charge level counts. Being plugged in does not satisfy the requirement.
- The requirement is re-evaluated live: overall status flips to Ready as soon as the charge reaches the minimum, without a refresh.
- If the charge level cannot be determined, the requirement is treated as met.
- Battery health is not part of readiness: a Service-Recommended or Non-Genuine battery turns the row red but does not change the overall status.
- Omit the key, or set it to an empty value,
0, or anything that isn't a whole number from1to100(such as50%), to disable the requirement. It is also off when the battery tile is disabled. - The App Config Builder offers the minimum in steps of 5%.
Device Health
Monitor hardware component health for supervised iOS 27+ devices. This tile shows the status of key hardware components and identifies non-genuine parts or component failures. Device Health is informational only and does not affect the overall readiness status.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-device-health-enabled |
String | NO |
Enable device health monitoring tile |
Example:
<key>device-checker-device-health-enabled</key>
<string>YES</string>
Monitored Components:
- Baseband: Cellular modem hardware
- Camera: Camera module
- Display: Display panel
- Face ID: TrueDepth camera system (Face ID-equipped devices)
- Touch ID: Fingerprint sensor (Touch ID-equipped devices)
- NFC: Near Field Communication chip
- Ultra Wideband: UWB chip (spatial awareness)
Component Status Values:
- OK: Component is functioning properly (green dot)
- Error: Component failure detected (red dot)
- Non-Genuine: Non-Apple component detected (orange dot)
Any other value is shown as Unknown with a gray dot. Values are matched in lowercase (ok, error, non-genuine); a differently spelled value such as OK is treated as an unrecognized issue.
The row subtitle reads "All components healthy", the affected component and its status (for example "Camera: Error"), or "N component issues".
Status Logic:
โ Green (Healthy): At least one component reported and all reported components have "OK" status
๐ด Red (Unhealthy): One or more components report anything other than "OK" (Error, Non-Genuine or an unrecognized value)
โช Gray (Unknown): No component data. The row subtitle reads "Requires iOS 27+" before iOS 27, "Not available for this device" on iOS 27+, or "No components reported". The detail screen explains whether the cause is the iOS version, lack of supervision or missing data.
Notes:
- Health data is reported by supervised iOS 27+ devices. The tile itself isn't blocked on older or unsupervised devices: it shows gray when no data is reported, and shows the real status if data is present
- Data comes from the Jamf Pro API's
systemHealthfield (maps to Apple'sdevice.system.healthdeclarative status) - Not all components report on every device model
- Device Health is informational only and is NOT included in the overall readiness status
- A device earlier than iOS 27 that reports no health data shows "Requires iOS 27+" in the tile subtitle with a gray status
Configuration Profiles
Shows the number of configuration profiles installed on the device. Tap the row to list each profile's name, identifier, version and UUID. Configuration Profiles is informational only and does not affect the overall readiness status.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-configuration-profiles-enabled |
String | NO |
Enable the configuration profiles tile |
Example:
<key>device-checker-configuration-profiles-enabled</key>
<string>YES</string>
Notes:
- Disabled by default; only
YES(case-insensitive) turns it on - Data comes from the
configurationProfilesfield ofGET /api/v2/mobile-devices/{id}/detail, already fetched on each check (no extra API calls or privileges) - The tile is gray ("Not reported yet") until device detail includes the
configurationProfilesfield. Once reported, the row is green and shows "N profiles installed" ("1 profile installed" for one), including when N is 0 - The detail screen opens with a plain-English summary (e.g. "12 configuration profiles are installed"); profiles are listed alphabetically by name (falling back to identifier), each collapsed to its name and expanding on tap to show the identifier, version and UUID that Jamf Pro reports
Certificates
Shows the number of certificates installed on the device and flags expired or soon-to-expire certificates. Tap the row for a plain-English summary (e.g. "1 certificate is expired and 1 expires within 30 days") and a list of certificates. Each certificate is collapsed to its common name (or its subject name, or "Unnamed Certificate"), with its Expired or Expiring Soon label visible; tap it to show whichever of these Jamf Pro reports: subject (when different from the name), issued and expiry dates, serial number, SHA-1 fingerprint, identity flag, status and lifecycle. Certificates is informational only and does not affect the overall readiness status.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-certificates-enabled |
String | NO |
Enable the certificates tile |
Example:
<key>device-checker-certificates-enabled</key>
<string>YES</string>
Status Logic:
โ Green: No certificates expired or expiring within 30 days
๐ Orange: One or more certificates expire within 30 days
๐ด Red: One or more certificates have expired
โช Gray (Unknown): The device record has no certificates data yet (subtitle "Not reported yet")
Notes:
- Disabled by default; only
YES(case-insensitive) turns it on - Data comes from the
certificatesfield ofGET /api/v2/mobile-devices/{id}/detail, already fetched on each check (no extra API calls or privileges) - The row subtitle reads "N certificates", followed by "ยท X expired" and "ยท Y expiring soon" when there are any
- Certificates are listed soonest expiry first; certificates with no readable expiry date come last and count as valid
- Expiry dates may be ISO 8601 text or epoch numbers (seconds or milliseconds)
Thermal State
Monitor device temperature in real-time using local iOS APIs (no MDM calls required).
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-thermal-enabled |
String | YES |
Enable thermal state monitoring tile |
Example:
<key>device-checker-thermal-enabled</key>
<string>YES</string>
Status Logic:
โ Green (Nominal): Normal operating temperature, all features operating normally
๐ Orange (Fair): Slightly elevated, system defers background work like prefetching/indexing
๐ด Red (Serious): High temperature, CPU/GPU throttling active, frame rates may drop to 30 FPS
๐ด Red (Critical): Device critically hot, significant throttling, camera/flash/speaker may disable, risk of shutdown
The status row uses the colors above. The large thermometer icon on the detail screen uses its own scale (green, amber, orange, red).
Use Cases: field devices in hot environments (vehicles, outdoor work), users running intensive apps (video recording, AR), proactive warnings before thermal shutdowns, and understanding performance throttling.
Notes: Real-time monitoring via iOS ProcessInfo API. No API calls or battery drain. Updates instantly when thermal state changes.
Performance (Memory & CPU)
Monitor device memory pressure and CPU usage using local iOS APIs with configurable thresholds.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-performance-enabled |
String | YES |
Enable performance monitoring tile |
device-checker-memory-warning |
Integer | 70 |
Memory warning threshold (% used) |
device-checker-memory-critical |
Integer | 85 |
Memory critical threshold (% used) |
device-checker-cpu-warning |
Integer | 60 |
CPU warning threshold (% usage) |
device-checker-cpu-critical |
Integer | 80 |
CPU critical threshold (% usage) |
Example:
<key>device-checker-performance-enabled</key>
<string>YES</string>
<key>device-checker-memory-warning</key>
<string>70</string>
<key>device-checker-memory-critical</key>
<string>85</string>
<key>device-checker-cpu-warning</key>
<string>60</string>
<key>device-checker-cpu-critical</key>
<string>80</string>
Status Logic:
๐ด Red (Critical): Memory OR CPU โฅ critical threshold
๐ Orange (Warning): Memory OR CPU โฅ warning threshold (but < critical)
โ Green (Ready): Both memory AND CPU < warning thresholds
Notes: Updates every 5 seconds, and only while the tile is on screen. No remote API calls required: entirely local monitoring via os_proc_available_memory() for memory and host_statistics() for CPU.
Network Status
Monitor WiFi, Ethernet, and cellular connectivity status.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-wifi-enabled |
String | YES |
Enable WiFi/Ethernet monitoring tile (Ethernet is auto-detected when connected) |
device-checker-cellular-enabled |
String | NO |
Enable cellular monitoring tile |
device-checker-network-speed-enabled |
String | NO |
Enable network speed test button in network detail views |
Example:
<key>device-checker-wifi-enabled</key>
<string>YES</string>
<key>device-checker-cellular-enabled</key>
<string>YES</string>
<key>device-checker-network-speed-enabled</key>
<string>YES</string>
Network Speed Test Details:
The speed test is an on-demand diagnostic tool (up to about 15 MB of data per test) that measures latency and download/upload speeds against Cloudflare's public speed test endpoints (speed.cloudflare.com):
- Latency: a zero-byte GET to
https://speed.cloudflare.com/__down?bytes=0(5-second timeout) - Download: up to 10 MB from
https://speed.cloudflare.com/__down, measured for a 5-second window from the first response byte - Upload: up to 5 MB of random data posted to
https://speed.cloudflare.com/__up(random so compression can't inflate the result), measured for a 5-second window
Download and upload each stop after 5 seconds of data (or when the data is used up) and report the rate over that window, so a slow link still finishes with a result. A step fails if no data moves for 10 seconds. The button becomes a Cancel button while testing, and leaving the screen or backgrounding the app cancels the test. A data usage warning is shown before every test on cellular (from the Cellular tile, or from the Wi-Fi tile when neither Wi-Fi nor Ethernet is connected). Results are informational only and do not affect device readiness status. Use cases include field workers verifying connectivity, troubleshooting slow performance, and validating bandwidth requirements.
Internet Connectivity Test (WiFi, Ethernet, and Cellular)
Lightweight test to verify actual internet reachability vs. just interface connectivity.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-internet-connectivity-test-enabled |
String | NO |
Enable internet connectivity test for all interfaces |
device-checker-internet-connectivity-test-endpoint |
String | https://captive.apple.com/hotspot-detect.html |
Test endpoint URL (Apple captive portal default). Use https://. A legacy http://captive.apple.com/... value is upgraded to https:// automatically |
device-checker-internet-connectivity-test-timeout |
String | 3 |
Request timeout in seconds (1โ10 range; values outside it are adjusted to the nearest limit, and a non-number is ignored) |
device-checker-internet-connectivity-test-cache-ttl |
String | 30 |
Cache result validity in seconds (10โ300 range, adjusted the same way; cellular uses minimum 60s) |
Example:
<key>device-checker-internet-connectivity-test-enabled</key>
<string>YES</string>
<key>device-checker-internet-connectivity-test-timeout</key>
<string>5</string>
<key>device-checker-internet-connectivity-test-cache-ttl</key>
<string>60</string>
How It Works: Sends a lightweight GET request (~500 bytes) to Apple's captive portal endpoint. The test passes only if the server returns a 2xx status and, for Apple's hotspot-detect.html endpoint, the response body contains "Success". This detects captive portals that answer with HTTP 200 and a login page. Custom endpoints only need to return a 2xx status. Tests run automatically when an interface connects or when network detail views are opened (if cache has expired). Results are cached for the configured TTL (30 seconds by default) on WiFi/Ethernet and a minimum of 60 seconds on cellular to minimize data usage. The Wi-Fi/Ethernet tile shows orange/warning status if connected but no internet is detected. The Cellular tile doesn't change color; it shows the result as an "Internet Access" row in its detail view.
Status Behavior by Interface:
WiFi / Ethernet (one tile): Ethernet is shown in the Wi-Fi tile and takes precedence while it is connected. Green: connected, and either internet verified or no test result yet. Orange: connected but the test found no internet (captive portal, routing or firewall issue). Red: neither Wi-Fi nor Ethernet is connected.
Cellular: The tile color doesn't depend on the connectivity test. Green: cellular data available. Orange: cellular access restricted for the app, or no SIM. Red: cellular not available. When cellular is the only network and access is restricted, the app shows a "Cellular Data Disabled" alert with an Open Settings button.
Data Usage: ~500 bytes per test (vs up to about 15 MB for the speed test). WiFi/Ethernet with 30-second cache: less than 100 KB/day typical usage. Cellular with 60-second cache: less than 50 KB/day typical usage.
Status Logic Without Internet Connectivity Test:
WiFi / Ethernet: โ Green (Connected): Connected to WiFi or Ethernet. ๐ด Red (Not Connected): Not connected to either.
Cellular: โ Green (Ready): Cellular data available. ๐ Orange (Warning): Cellular access restricted, or no SIM. ๐ด Red (Error): Cellular not available.
Jamf Setup Extension Attribute (Setup Status & Off Duty)
Use a Jamf Pro extension attribute to show the device's setup status in the header and to take devices off duty. There is no separate tile for this EA.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-jamf-setup-ea-enabled |
String | NO |
Enable Setup Status and on-duty/off-duty handling |
device-checker-jamf-setup-ea-name |
String | Jamf Setup |
Name of extension attribute in Jamf Pro |
device-checker-jamf-setup-ea-on-duty-value |
String | On-duty |
Value that indicates "on-duty" |
device-checker-jamf-setup-ea-off-duty-value |
String | Off-duty |
Value that indicates "off-duty" |
device-checker-jamf-setup-ea-toggle-enabled |
String | NO |
Let the user switch between on-duty and off-duty from the app |
Example:
<key>device-checker-jamf-setup-ea-enabled</key>
<string>YES</string>
<key>device-checker-jamf-setup-ea-name</key>
<string>Jamf Setup</string>
<key>device-checker-jamf-setup-ea-on-duty-value</key>
<string>On-duty</string>
<key>device-checker-jamf-setup-ea-off-duty-value</key>
<string>Off-duty</string>
<key>device-checker-jamf-setup-ea-toggle-enabled</key>
<string>NO</string>
Setup Status Line: When enabled, the Status tab header shows "Setup Status: value" above the overall status, using the EA's current value ("<blank>" if the value is an empty string, "unknown" if the EA isn't on the device record, has no value, or no check has completed yet).
Status Logic (overall status):
โ On duty: EA value matches the on-duty value. Readiness is evaluated normally (Ready, Action Needed, Deadline Approaching or Not Ready).
โช Gray (Off Duty): EA value matches the off-duty value. The overall status shows the off-duty value as its title (for example Off Duty; "Off Duty" if the value is blank) with a moon icon (moon.zzz) and "Device is not currently on duty".
โช Gray (Unknown): EA not found, or its value doesn't match either configured value.
While Off Duty, the Requirements and Device Status sections are still shown for information, but the overall status stays Off Duty whatever the requirements report. While Unknown, both sections are hidden.
User Toggle: When device-checker-jamf-setup-ea-toggle-enabled is YES, a Tap to change to <off-duty value> (orange) or Tap to change to <on-duty value> (green) button, named after the configured EA values, appears under the Setup Status line. After the user confirms in a "Change Device Status?" alert, the app sets the EA on the device record (PATCH /api/v2/mobile-devices/{id}, OAuth) and updates the overall status right away; if the update fails (Jamf Pro rejects it or can't be reached), the previous value is restored and an "Update Failed" alert ("Could not update device status. Please try again.") is shown. The same alert appears, with no change made, if the EA can't be found on the device record. The button is hidden when the EA value matches neither configured value. It is replaced by a spinner while the update is running, and disabled while a check is running or while the app is showing last known status because the server can't be reached. This requires the Update Mobile Devices privilege on the linked app's API role (re-run the wizard on existing installs to add it), and the EA must be an editable text field EA (not populated by a script or LDAP).
Notes: Requires a custom extension attribute in Jamf Pro. The extension attribute must be populated by Jamf Setup or another method. The EA name and values are matched exactly (case-sensitive).
Auto-Refresh Throttling
Control how often the app automatically refreshes when returning from the background.
| Key | Type | Default | Description |
|---|---|---|---|
device-checker-auto-refresh-threshold |
Integer | 300 |
Minimum seconds between automatic refreshes (range: 60โ3600, or 0 to disable) |
Example:
<key>device-checker-auto-refresh-threshold</key>
<string>300</string>
Behavior:
- Default (300 seconds / 5 minutes): If the user switches apps and returns within 5 minutes, no auto-refresh occurs
- Custom threshold: Set to desired seconds (60โ3600). Values from 1 to 59 are raised to 60, values above 3600 are lowered to 3600, and a value that isn't a number is ignored (the default of 300 applies)
- Disable throttling: Set to
0to always refresh when app becomes active
Always refreshes (throttling bypassed): first activation after app launch, when in pending state (auto-refreshes every 2 minutes), when the last check failed (the cached-data banner is showing), manual refresh button taps, and timer expiration during pending state.
Pending State Behavior: When the Apps row enters "Pending" state (after user taps "Update"), the app automatically checks device status every 2 minutes until all required apps are installed, regardless of the auto-refresh threshold setting.
Configuration Examples
Minimal Configuration (Default Settings)
Perfect for quick testing or basic deployments.
<dict>
<!-- Required keys (auto-populated) -->
<key>JPS_URL</key>
<string>$JPS_URL</string>
<key>JSSID</key>
<string>$JSSID</string>
<key>MANAGEMENTID</key>
<string>$MANAGEMENTID</string>
<key>OAUTH_AUTH_CODE</key>
<string>$OAUTH_AUTH_CODE</string>
<key>APP_CONFIG_REINSTALL_CODE</key>
<string>$APP_CONFIG_REINSTALL_CODE</string>
<key>APPJSSID</key>
<string>$APPJSSID</string>
<!-- Enable OS monitoring only -->
<key>device-checker-os-enabled</key>
<string>YES</string>
<key>device-checker-os-min-version</key>
<string>18.0</string>
</dict>
Full Configuration
Comprehensive setup with branding, multiple device status checks, and custom thresholds.
<dict>
<!-- Required keys (auto-populated) -->
<key>JPS_URL</key>
<string>$JPS_URL</string>
<key>JSSID</key>
<string>$JSSID</string>
<key>MANAGEMENTID</key>
<string>$MANAGEMENTID</string>
<key>OAUTH_AUTH_CODE</key>
<string>$OAUTH_AUTH_CODE</string>
<key>APP_CONFIG_REINSTALL_CODE</key>
<string>$APP_CONFIG_REINSTALL_CODE</string>
<key>APPJSSID</key>
<string>$APPJSSID</string>
<!-- Branding -->
<key>device-checker-branding-image-url</key>
<string>https://yourcompany.com/logo.png</string>
<key>device-checker-branding-image-height</key>
<string>60</string>
<!-- OS Readiness -->
<key>device-checker-os-enabled</key>
<string>YES</string>
<key>device-checker-os-min-version</key>
<string>18.0</string>
<key>device-checker-os-exact-version</key>
<string>NO</string>
<key>device-checker-os-deadline</key>
<string>2026-12-31</string>
<!-- App Readiness -->
<key>device-checker-apps-enabled</key>
<string>YES</string>
<key>device-checker-apps-list</key>
<string>Slack,com.tinyspeck.chatlyio,24.0.0,2026-06-01|Microsoft Teams,com.microsoft.skype.teams,5.0.0,2026-09-01</string>
<key>device-checker-apps-exact-version</key>
<string>NO</string>
<!-- Device Health Tiles -->
<key>device-checker-power-source-enabled</key>
<string>YES</string>
<key>device-checker-power-source-warning</key>
<string>30</string>
<key>device-checker-power-source-critical</key>
<string>15</string>
<key>device-checker-storage-enabled</key>
<string>YES</string>
<key>device-checker-storage-warning</key>
<string>70</string>
<key>device-checker-storage-critical</key>
<string>85</string>
<key>device-checker-battery-enabled</key>
<string>YES</string>
<!-- Optional: minimum charge % (1-100) required for Ready; leave out to disable -->
<key>device-checker-battery-min-level</key>
<string>50</string>
<key>device-checker-thermal-enabled</key>
<string>YES</string>
<key>device-checker-performance-enabled</key>
<string>YES</string>
<key>device-checker-memory-warning</key>
<string>75</string>
<key>device-checker-memory-critical</key>
<string>90</string>
<key>device-checker-cpu-warning</key>
<string>70</string>
<key>device-checker-cpu-critical</key>
<string>85</string>
<key>device-checker-wifi-enabled</key>
<string>YES</string>
<key>device-checker-cellular-enabled</key>
<string>NO</string>
<!-- Network Speed Test (optional - disabled by default) -->
<key>device-checker-network-speed-enabled</key>
<string>NO</string>
<!-- Internet Connectivity Test (optional - disabled by default) -->
<key>device-checker-internet-connectivity-test-enabled</key>
<string>NO</string>
<key>device-checker-internet-connectivity-test-endpoint</key>
<string>https://captive.apple.com/hotspot-detect.html</string>
<key>device-checker-internet-connectivity-test-timeout</key>
<string>3</string>
<key>device-checker-internet-connectivity-test-cache-ttl</key>
<string>30</string>
<!-- Jamf Setup EA -->
<key>device-checker-jamf-setup-ea-enabled</key>
<string>YES</string>
<key>device-checker-jamf-setup-ea-name</key>
<string>Device Status</string>
<key>device-checker-jamf-setup-ea-on-duty-value</key>
<string>Active</string>
<key>device-checker-jamf-setup-ea-off-duty-value</key>
<string>Spare Pool</string>
<key>device-checker-jamf-setup-ea-toggle-enabled</key>
<string>NO</string>
<!-- UI Options -->
<key>device-checker-alerts-url</key>
<string>https://status.yourcompany.com</string>
<key>device-checker-send-status-enabled</key>
<string>YES</string>
<key>device-checker-send-logs-enabled</key>
<string>NO</string>
<key>device-checker-clear-logs-enabled</key>
<string>NO</string>
<key>device-checker-status-tab-scrollable</key>
<string>NO</string>
<key>device-checker-ai-summary-enabled</key>
<string>NO</string>
<!-- Auto-Refresh (10 minutes) -->
<key>device-checker-auto-refresh-threshold</key>
<string>600</string>
<!-- Device Health (iOS 27+) -->
<key>device-checker-device-health-enabled</key>
<string>NO</string>
<!-- Configuration Profiles / Certificates -->
<key>device-checker-configuration-profiles-enabled</key>
<string>NO</string>
<key>device-checker-certificates-enabled</key>
<string>NO</string>
<!-- Links -->
<key>device-checker-links-enabled</key>
<string>NO</string>
<key>device-checker-links-list</key>
<string>[{"title":"Support Portal","url":"https://support.company.com"}]</string>
<!-- Spinner Style -->
<key>device-checker-spinner-style</key>
<string>default</string>
</dict>
Legal
- Use Agreement: Application End User License Agreement
- Privacy Policy: Jamf Privacy Policy
Version 1.2.8