Connect Jamf Pro
Jamf Pro is Apple device management. It enrolls and manages Macs, iPhones, iPads and Apple TVs: it holds the inventory, deploys software and configuration profiles, enforces settings, runs scripts and…
Written By Christopher Scaminaci
Last updated About 22 hours ago
Jamf Pro is Apple device management. It enrolls and manages Macs, iPhones, iPads and Apple TVs: it holds the inventory, deploys software and configuration profiles, enforces settings, runs scripts and policies, handles patching, and sends the commands that lock, wipe or unmanage a device. If you support Apple hardware, Jamf Pro is usually the system that knows the truth about it.
Connecting Jamf Pro to StackJack gives your AI assistant a family of jamf_ MCP tools — MCP (Model Context Protocol) tools are the standardized commands an AI assistant can call through StackJack. With them, your AI can:
- Answer questions about the fleet — which Macs are on which macOS version, what is installed on a given machine, which devices have not checked in, which are unencrypted, and what changed in a device's history
- Look up a single device fast — full inventory for one Mac or iPhone by id or name, its group memberships, its applications, its management history, and the policies and profiles scoped to it
- Report on deployment — which policies and configuration profiles exist, what each one is scoped to, which packages and scripts are in use, and where patch management stands per software title
- Track enrollment — devices waiting to enroll, prestage enrollment configurations, Automated Device Enrollment records, and inventory preload rows
- Audit access — Jamf Pro accounts and groups, LDAP and single sign-on configuration, API roles and the API clients assigned to them, sites, and network segments
- See the organization — users, user groups, classes, buildings, departments, categories, and volume purchasing content and assignments
- Change device management (on Pro plans) — create and update policies, groups, profiles, scripts, packages, extension attributes and prestage configurations
- Act on devices (on Pro plans) — send the MDM commands that lock, erase, restart, update inventory, enable Lost Mode, or unmanage a device
- Manage patching and updates (on Pro plans) — patch policies, software title configurations, and managed software update plans
How StackJack authenticates to Jamf Pro
StackJack signs in with a Jamf Pro API client — a Client ID and Client Secret you create inside Jamf Pro. This is not your own Jamf Pro login and it is not an SSO account, so it keeps working when a technician leaves, and Jamf Pro records the API client as the actor on anything StackJack changes.
An API client gets its permissions from an API role you assign to it. That role, and nothing else, decides what StackJack can do. Give the role read privileges and StackJack can report but not change anything.
Behind the scenes, Jamf Pro does not accept the Client ID and Secret on each request: it exchanges them for a short-lived access token first. StackJack handles that exchange, keeps the token fresh, and gets a new one automatically when it expires. You never see it.
Steps
- Open API roles and clients. In Jamf Pro, go to Settings, then System, then API roles and clients.
- Create an API role. On the API Roles tab, create a role and name it something clear such as "StackJack". Select the privileges you want StackJack to have. Read privileges are enough for everything StackJack reports on; add the matching Create, Update or Delete privileges only for the areas you want it to change. See the section below before you grant the device-command privileges.
- Create an API client. On the API Clients tab, create a client, assign it the role you just made, and set the access token lifetime. StackJack renews the token on its own, so the default lifetime is fine.
- Enable the client and copy its credentials. Enable the API client, then copy the Client ID and generate a Client Secret. The secret is shown once and cannot be retrieved later, so copy it before you close the page.
- Enter the details in StackJack. Open Connectors, choose Jamf Pro, and paste your Jamf Pro server URL, the Client ID and the Client Secret.
- Run a Test Connection to confirm StackJack can reach your server with those credentials.
Your server address
Enter the address of your Jamf Pro server and nothing else — for Jamf Cloud that is the one ending in .jamfcloud.com, and for a server you host yourself it is your own hostname. Do not add a path such as /api or /JSSResource; StackJack adds whichever one it needs.
If your Jamf Pro server is only reachable from inside your network, StackJack cannot connect to it. StackJack reaches your server from the internet, so it needs a publicly reachable address with a valid certificate.
What to know before your AI uses this connector
Some tools act on real hardware
This is the most important thing about the Jamf Pro connector. Jamf Pro is not only a record of your devices — it is the thing that commands them, and several tools take effect on hardware in someone's hands:
- Erase and wipe remove everything from a device. There is no undo, and on a personal or shared device the data is gone.
- Lock makes a device unusable until a passcode is entered. Recovering a locked Mac needs the unlock PIN that Jamf Pro generated at the time.
- Restart and shut down interrupt whoever is using the device, immediately.
- Unmanage and disown cut a device loose from Jamf Pro. Bringing it back usually means re-enrolling it in person.
- Clear passcode removes the screen lock from a mobile device.
- Enable Lost Mode locks a device and shows a message on it, and can report its location.
All of these need the Pro tier and are marked destructive. Whether your AI application asks you to confirm before running one depends on that application's own settings — see Destructive tools and confirmation.
The privileges on your API role are the real control here. If you do not want an AI to be able to wipe a Mac, do not grant the role the privilege to send that command. That is a stronger guarantee than any instruction you give the assistant.
Deleting a Jamf Pro record removes it everywhere
Jamf Pro objects are shared. Deleting a policy, a configuration profile, a smart group, a script or a package removes it from every device it was scoped to, and the effect reaches those devices at their next check-in. Deleting a category or a department can leave the records that referenced it without one.
Every delete tool needs the Pro tier and is marked destructive.
Updates replace, they do not merge
Most Jamf Pro update tools send a complete replacement record rather than a patch. If you send a policy without its scope, the policy ends up with no scope. The safe pattern is to read the object first, change what you need in the returned document, and send that back. Your AI assistant does this by default when you ask it to change something specific, but it is worth knowing why it reads before it writes.
Jamf checks privileges per object and per method. Create on policies does not include Read, so a role that can create a policy cannot read it back, and the read-then-write pattern above needs Read as well as Update on the object. One more trap on the older Classic API: it reports a missing privilege as a sign-in failure rather than a permission error, so a refusal that looks like a bad credential on one call while the others work is nearly always a privilege the role does not hold.
Jamf Pro has two APIs, and StackJack uses both
Jamf Pro serves a current API and an older one it still supports, and different features live in each. StackJack uses both, with the same credentials, so you do not have to think about which is which. You will see it in the tool names: a tool with classic in its name is served by the older API.
One practical consequence: a handful of the older API's write tools ask for the record as an XML document, because that is the only format that API accepts. Your AI assistant reads the existing record first and uses its shape, so this is rarely something you need to handle yourself.
Results come back a page at a time
Large reads are paginated. StackJack limits how many records one call can ask for so a single question cannot pull your entire fleet in one request. When your AI needs more, it asks for the next page. Searches on the current API accept a filter expression, which your assistant builds for you from what you asked for.
Your Jamf Pro version matters
StackJack is built against Jamf Pro 11.31. An older server does not serve every endpoint, so a tool may report that a resource does not exist. That is your server's version, not a broken connection.
Several customers
Every customer has their own Jamf Pro server. Add one connection per customer from the connector's card, name it after the customer, and your AI names it on each call. Omit the name and the call runs against your default connection. Pin an endpoint to one connection when an AI should never reach past a single customer. See Several connections of one connector.
Reference
A complete list of every Jamf Pro tool, with what each one does and which plan it needs, is in the Jamf Pro tool reference.
Jamf Pro tools
jamf_ · 1292 tools · Free 661 · Pro 631
Advanced Computer Searches (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new advanced computer search. |
jamf_Pro · Destructive | Deletes a computer search by ID. |
jamf_Pro · Destructive | Deletes a computer search by name. |
jamf_Free · Read-only | Finds computer searches by ID. |
jamf_Free · Read-only | Finds advanced computer searches by name. |
jamf_Free · Read-only | Finds all advanced computer searches. |
jamf_Pro · Destructive | Updates an existing advanced computer search by ID. |
jamf_Pro · Destructive | Updates an existing advanced computer search by name. |
Computer Application Usage (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Finds computer application usage by computer ID. |
jamf_Free · Read-only | Finds computer application usage by computer MAC address. |
jamf_Free · Read-only | Finds computer application usage by computer name. |
jamf_Free · Read-only | Finds computer application usage by computer serial number. |
jamf_Free · Read-only | Finds computer application usage by computer UDID. |
Computer Applications (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Finds computer applications by name. |
jamf_Free · Read-only | Finds computer applications by name with additional display fields. |
jamf_Free · Read-only | Finds computer applications by name and version. |
jamf_Free · Read-only | Finds computer applications by name and version. |
Computer Check-In (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Finds the Jamf Pro computer checkin information. |
jamf_Pro · Destructive | Updates the Jamf Pro computer checkin information. |
Computer Commands (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Creates a new computer command using command name. |
jamf_Pro · Destructive | Creates a new computer command using command name and device IDs. |
jamf_Free · Read-only | Finds all computer commands by name. |
jamf_Free · Read-only | Finds a computer command by UUID. |
jamf_Free · Read-only | Finds all computer commands. |
Computer Extension Attributes
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create Computer Extension Attribute. |
jamf_Pro · Write | Add specified Computer Extension Attribute history object notes. |
jamf_Pro · Destructive | Remove specified Computer Extension Attribute. |
jamf_Pro · Destructive | Delete multiple Computer Extension Attribute at once. |
jamf_Free · Read-only | Get specified Computer Extension Attribute object. |
jamf_Free · Read-only | Get specified Computer Extension Attribute Template object. |
jamf_Free · Read-only | Retrieve Computer Extension Attributes. |
jamf_Free · Read-only | Get smart group/advance search dependent objects for a specified computer extension attribute. |
jamf_Free · Read-only | Download the specified Computer Extension Attribute. |
jamf_Free · Read-only | Get specified Computer Extension Attribute History object. |
jamf_Free · Read-only | Retrieve All Computer Extension Attributes Templates. |
jamf_Pro · Destructive | Update specified Computer Extension Attribute object. |
jamf_Pro · Destructive | Upload Computer Extension Attribute. |
Computer Extension Attributes (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new computer extension attribute by ID. |
jamf_Pro · Destructive | Deletes a computer extension attribute by ID. |
jamf_Pro · Destructive | Deletes a computer extension attribute by name. |
jamf_Free · Read-only | Finds computer extension attributes by ID. |
jamf_Free · Read-only | Finds computer extension attributes by name. |
jamf_Free · Read-only | Finds all computer extension attributes. |
jamf_Pro · Destructive | Updates an existing computer extension attribute by ID. |
jamf_Pro · Destructive | Updates an existing computer extension attribute by name. |
Computer Groups
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create a Smart Computer Group. |
jamf_Pro · Write | Create membership of a static computer group. |
jamf_Pro · Destructive | Remove specified Smart Computer Group. |
jamf_Pro · Destructive | Remove Static Computer Group by Id. |
jamf_Free · Read-only | Get the membership of a Smart Computer Group. |
jamf_Free · Read-only | Get Smart Computer Group by Id. |
jamf_Free · Read-only | Get Static Computer Group by Id. |
jamf_Free · Read-only | Returns the list of all computer groups. |
jamf_Free · Read-only | Search for Smart Computer Groups. |
jamf_Free · Read-only | Search for Static Computer Groups. |
jamf_Pro · Destructive | Update a Smart Computer Group. |
jamf_Pro · Destructive | Update membership of a static computer group. |
Computer Groups (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new computer group by ID. |
jamf_Pro · Destructive | Deletes a computer group by ID. |
jamf_Pro · Destructive | Deletes a computer group by name. |
jamf_Free · Read-only | Finds computer groups by ID. |
jamf_Free · Read-only | Finds computer groups by name. |
jamf_Free · Read-only | Finds all computer groups. |
jamf_Pro · Destructive | Updates an existing computer group by ID. |
jamf_Pro · Destructive | Updates an existing computer group by name. |
Computer Hardware and Software Reports (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Finds hardware/software reports by computer ID. |
jamf_Free · Read-only | Finds a subset of hardware/software reports by computer ID. |
jamf_Free · Read-only | Finds hardware/software reports by computer MAC address. |
jamf_Free · Read-only | Finds hardware/software reports by computer name. |
jamf_Free · Read-only | Finds a subset of hardware/software reports by computer name. |
jamf_Free · Read-only | Finds hardware/software reports by computer serial number. |
jamf_Free · Read-only | Finds hardware/software reports by computer UDID. |
jamf_Free · Read-only | Finds a subset of hardware/software reports by computer UDID. |
jamf_Free · Read-only | Finds a subset of hardware/software reports by computer MAC address. |
jamf_Free · Read-only | Finds a subset of hardware/software reports by computer serial number. |
Computer History (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Finds computer history by ID. |
jamf_Free · Read-only | Finds a subset of computer history data by ID. |
jamf_Free · Read-only | Finds computer history by MAC address. |
jamf_Free · Read-only | Finds a subset of computer history data by MAC address. |
jamf_Free · Read-only | Finds computer history by name. |
jamf_Free · Read-only | Finds a subset of computer history data by name. |
jamf_Free · Read-only | Finds computer history by serial number. |
jamf_Free · Read-only | Finds a subset of computer history data by serial number. |
jamf_Free · Read-only | Finds computer history by UDID. |
jamf_Free · Read-only | Finds a subset of computer history data by UDID. |
Computer Inventory
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Remove a computer's MDM profile. |
jamf_Pro · Destructive | Erase a computer. |
Computer Inventory Collection (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Finds the Jamf Pro computer inventory collection information. |
jamf_Pro · Destructive | Updates the Jamf Pro computer inventory collection information. |
Computer Inventory Collection Settings
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create Computer Inventory Collection Settings Custom Path. |
jamf_Pro · Destructive | Delete Custom Path from Computer Inventory Collection Settings. |
jamf_Free · Read-only | Returns computer inventory settings. |
jamf_Pro · Write | Update computer inventory settings. |
Computer Invitations (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Creates a new computer invitation by id. |
jamf_Pro · Destructive | Creates a new computer invitation by invitation. |
jamf_Pro · Destructive | Deletes a computer invitation by id. |
jamf_Pro · Destructive | Deletes a computer invitation by invitation. |
jamf_Free · Read-only | Finds computer invitations by id. |
jamf_Free · Read-only | Finds computer invitations by invitation. |
jamf_Free · Read-only | Finds all computer invitations. |
Computer Management (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Finds computer management information by ID. |
jamf_Free · Read-only | Display patch management information for a computer and filter. |
jamf_Free · Read-only | Finds a subset of computer management information by ID. |
jamf_Free · Read-only | Finds management information for a computer and username. |
jamf_Free · Read-only | Finds a subset of management information for a computer and username. |
jamf_Free · Read-only | Finds computer management information by MAC address. |
jamf_Free · Read-only | Display patch management information for a computer and filter. |
jamf_Free · Read-only | Finds a subset of computer management information by MAC address. |
jamf_Free · Read-only | Finds management information for a computer and username. |
jamf_Free · Read-only | Finds a subset of management information for a computer and username. |
jamf_Free · Read-only | Finds computer management information by name. |
jamf_Free · Read-only | Display patch management information for a computer and filter. |
jamf_Free · Read-only | Finds a subset of computer management information by name. |
jamf_Free · Read-only | Finds management information for a computer and username. |
jamf_Free · Read-only | Finds a subset of management information for a computer and username. |
jamf_Free · Read-only | Finds computer management information by serial number. |
jamf_Free · Read-only | Display patch management information for a computer and filter. |
jamf_Free · Read-only | Finds a subset of computer management information by serial number. |
jamf_Free · Read-only | Finds management information for a computer and username. |
jamf_Free · Read-only | Finds a subset of management information for a computer and username. |
jamf_Free · Read-only | Finds computer management information by UDID. |
jamf_Free · Read-only | Display patch management information for a computer and filter. |
jamf_Free · Read-only | Finds a subset of computer management information by UDID. |
jamf_Free · Read-only | Finds management information for a computer and username. |
jamf_Free · Read-only | Finds a subset of management information for a computer and username. |
Computer Prestages
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create a Computer Prestage. |
jamf_Pro · Write | Add device Scope for a specific Computer Prestage. |
jamf_Pro · Destructive | Delete a Computer Prestage with the supplied id. |
jamf_Pro · Destructive | Remove device Scope for a specific Computer Prestage. |
jamf_Free · Read-only | Retrieve a Computer Prestage with the supplied id. |
jamf_Free · Read-only | Get sorted and paged Computer Prestages. |
jamf_Free · Read-only | Get all device Scope for all Computer Prestages. |
jamf_Free · Read-only | Get device Scope for a specific Computer Prestage. |
jamf_Pro · Destructive | Update a Computer Prestage. |
jamf_Pro · Destructive | Replace device Scope for a specific Computer Prestage. |
Computer Reports (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Finds computer reports by id. |
jamf_Free · Read-only | Finds computer reports by name. |
jamf_Free · Read-only | Finds all computer reports. |
Computers
| Tool | What it does |
|---|---|
jamf_Pro · Write | Recalculate a smart group for the given id. |
Computers (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a computer. |
jamf_Pro · Destructive | Deletes a computer by ID. |
jamf_Pro · Destructive | Deletes a computer by MAC address. |
jamf_Pro · Destructive | Deletes a computer by name. |
jamf_Pro · Destructive | Deletes a computer by serial number. |
jamf_Pro · Destructive | Deletes a computer by UDID. |
jamf_Free · Read-only | Finds computers by ID. |
jamf_Free · Read-only | Finds a subset of information for a computer. |
jamf_Free · Read-only | Finds computers by MAC address. |
jamf_Free · Read-only | Finds a subset of data for computers by MAC address. |
jamf_Free · Read-only | Searches for computers that match the provided parameter. |
jamf_Free · Read-only | Searches for computers that match the provided name parameter. |
jamf_Free · Read-only | Finds the first computer with the given name. |
jamf_Free · Read-only | Finds a subset of data for the first computer with the given name. |
jamf_Free · Read-only | Finds computers by serial number. |
jamf_Free · Read-only | Finds a subset of data for computers by serial number. |
jamf_Free · Read-only | Finds computers by UDID. |
jamf_Free · Read-only | Finds a subset of data for computers by UDID. |
jamf_Free · Read-only | Finds all computers. |
jamf_Free · Read-only | Finds basic information for all computers. |
jamf_Pro · Destructive | Updates an existing computer by ID. |
jamf_Pro · Destructive | Updates an existing computer by MAC address. |
jamf_Pro · Destructive | Updates an existing computer by name. |
jamf_Pro · Destructive | Updates an existing computer by serial number. |
jamf_Pro · Destructive | Updates an existing computer by UDID. |
Computers Inventory
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create Computer Inventory record. |
jamf_Pro · Destructive | Upload attachment and assign to computer. |
jamf_Pro · Destructive | Remove a computer's MDM profile. |
jamf_Pro · Destructive | Remove specified Computer record. |
jamf_Pro · Destructive | Remove attachment. |
jamf_Pro · Destructive | Erase a computer. |
jamf_Free · Read-only | Return General section of a Computer. |
jamf_Free · Read-only | Download attachment file. |
jamf_Free · Read-only | Return paginated Computer Inventory records. |
jamf_Free · Read-only | Return paginated FileVault information for all computers. |
jamf_Free · Read-only | Return FileVault information for a specific computer. |
jamf_Free · Read-only | Return a computer's Device Lock PIN. |
jamf_Free · Read-only | Return a Computers Recovery Lock Password. |
Computers Inventory Detail
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Return all sections of a computer. |
jamf_Pro · Write | Update specific fields on a computer. |
Local Administrator Password (LAPS)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Get LAPS password viewed history. |
jamf_Free · Read-only | Get LAPS password viewed history. |
jamf_Free · Read-only | Get LAPS historical records for target device and username. |
jamf_Free · Read-only | Get LAPS historical records for target device and user guid. |
jamf_Free · Read-only | Get current LAPS password for specified username on a client. |
jamf_Free · Read-only | Get current LAPS password for specified user guid on a client. |
jamf_Free · Read-only | Get the LAPS capable admin accounts for a device. |
jamf_Free · Read-only | Get LAPS password viewed history, and rotation history. |
jamf_Free · Read-only | Get a list of the current devices and usernames with pending LAPS rotations. |
jamf_Free · Read-only | Get the current LAPS settings. |
jamf_Pro · Destructive | Set the LAPS password for a device. |
jamf_Pro · Destructive | Update settings for LAPS. |
Smart Computer Groups
| Tool | What it does |
|---|---|
jamf_Pro · Write | Recalculate the smart group for the given id. |
Advanced Mobile Device Searches
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create Advanced Search object. |
jamf_Pro · Destructive | Remove specified Advanced Search object. |
jamf_Pro · Destructive | Remove specified Advanced Search objects. |
jamf_Free · Read-only | Get specified Advanced Search object. |
jamf_Free · Read-only | Get Advanced Search objects. |
jamf_Free · Read-only | Get Mobile Device Advanced Search criteria choices. |
jamf_Pro · Destructive | Get specified Advanced Search object. |
Advanced Mobile Device Searches (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new advanced mobile device search. |
jamf_Pro · Destructive | Deletes a mobile device search by ID. |
jamf_Pro · Destructive | Deletes a mobile device search by name. |
jamf_Free · Read-only | Finds mobile device searches by ID. |
jamf_Free · Read-only | Finds advanced mobile device searches by name. |
jamf_Free · Read-only | Finds all advanced mobile device searches. |
jamf_Pro · Destructive | Updates an existing advanced mobile device search by ID. |
jamf_Pro · Destructive | Updates an existing advanced mobile device search by name. |
Devices
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Get Mobile Device Extension Attribute values placed in select paramter. |
jamf_Free · Read-only | Return a list of groups for a device. |
Mobile Device Applications (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new mobile device application by ID. |
jamf_Pro · Destructive | Deletes a mobile device application by bundle ID. |
jamf_Pro · Destructive | Deletes a mobile device application by bundle ID and version. |
jamf_Pro · Destructive | Deletes a mobile device application by ID. |
jamf_Pro · Destructive | Deletes a mobile device application by name. |
jamf_Free · Read-only | Finds mobile device applications by bundle ID. |
jamf_Free · Read-only | Finds mobile device applications by bundle ID and version. |
jamf_Free · Read-only | Finds mobile device applications by ID. |
jamf_Free · Read-only | Finds a subset of data for a mobile device application by ID. |
jamf_Free · Read-only | Finds mobile device applications by name. |
jamf_Free · Read-only | Finds a subset of data for mobile device applications by name. |
jamf_Free · Read-only | Finds all mobile device applications. |
jamf_Pro · Destructive | Updates an existing mobile device application by bundle ID. |
jamf_Pro · Destructive | Updates an existing mobile device application by bundle ID and version. |
jamf_Pro · Destructive | Updates an existing mobile device application by ID. |
jamf_Pro · Destructive | Updates an existing mobile device application by name. |
Mobile Device Apps
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Reinstall App Config for Managed iOS Apps. |
Mobile Device Commands (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Creates a new mobile device command. |
jamf_Pro · Destructive | Creates a new mobile device command. |
jamf_Free · Read-only | Finds all mobile device commands for specified command. |
jamf_Free · Read-only | Finds all mobile device commands by command name. |
jamf_Free · Read-only | Finds a mobile device command by UUID. |
jamf_Free · Read-only | Finds all mobile device commands. |
Mobile Device Configuration Profiles (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new mobile device configuration profile by ID. |
jamf_Pro · Destructive | Deletes a mobile device configuration profile by ID. |
jamf_Pro · Destructive | Deletes a mobile device configuration profile by name. |
jamf_Free · Read-only | Finds mobile device configuration profiles by ID. |
jamf_Free · Read-only | Finds a subset of data for a mobile device configuration profile by ID. |
jamf_Free · Read-only | Finds mobile device configuration profiles by name. |
jamf_Free · Read-only | Finds a subset of data for mobile device configuration profiles by name. |
jamf_Free · Read-only | Finds all mobile device configuration profiles. |
jamf_Pro · Destructive | Updates an existing mobile device configuration profile by ID. |
jamf_Pro · Destructive | Updates an existing mobile device configuration profile by name. |
Mobile Device Enrollment Profile
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Retrieve the MDM Enrollment Profile. |
Mobile Device Enrollment Profiles (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new mobile device enrollment profile by ID. |
jamf_Pro · Destructive | Deletes a mobile device enrollment profile by ID. |
jamf_Pro · Destructive | Deletes a mobile device enrollment profile by invitation. |
jamf_Pro · Destructive | Deletes a mobile device enrollment profile by name. |
jamf_Free · Read-only | Finds mobile device enrollment profiles by ID. |
jamf_Free · Read-only | Finds a subset of data for an enrollment profile. |
jamf_Free · Read-only | Finds mobile device enrollment profiles by invitation. |
jamf_Free · Read-only | Finds mobile device enrollment profiles by name. |
jamf_Free · Read-only | Finds a subset of data for mobile device enrollment profiles by name. |
jamf_Free · Read-only | Finds all mobile device enrollment profiles. |
jamf_Pro · Destructive | Updates an existing mobile device enrollment profile by ID. |
jamf_Pro · Destructive | Updates an existing mobile device enrollment profile by invitation. |
jamf_Pro · Destructive | Updates an existing mobile device enrollment profile by name. |
Mobile Device Extension Attributes
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create Mobile Device Extension Attribute. |
jamf_Pro · Write | Add specified Mobile Device Extension Attribute history object notes. |
jamf_Pro · Destructive | Delete a Mobile Device Extension Attribute by ID. |
jamf_Free · Read-only | Get specified Mobile Device Extension Attribute object. |
jamf_Free · Read-only | Retrieve Mobile Device Extension Attributes. |
jamf_Free · Read-only | Get smart group dependent object for a specified mobile device extension attribute. |
jamf_Free · Read-only | Get specified Mobile Device Extension Attribute History object. |
jamf_Pro · Destructive | Update specified Mobile Device Extension Attribute object. |
Mobile Device Extension Attributes (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new mobile device extension attribute by ID. |
jamf_Pro · Destructive | Deletes a mobile device extension attribute by ID. |
jamf_Pro · Destructive | Deletes a mobile device extension attribute by name. |
jamf_Free · Read-only | Finds mobile device extension attributes by ID. |
jamf_Free · Read-only | Finds mobiledeviceextensionattributes by name. |
jamf_Free · Read-only | Finds all mobile device extension attributes. |
jamf_Pro · Destructive | Updates an existing mobile device extension attribute by ID. |
jamf_Pro · Destructive | Updates an existing mobile device extension attribute by name. |
Mobile Device Groups
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create a smart group. |
jamf_Pro · Write | Create a static group. |
jamf_Pro · Destructive | Remove Smart Group by Id. |
jamf_Pro · Destructive | Remove Static Group by Id. |
jamf_Pro · Destructive | Erase all devices in the group. |
jamf_Free · Read-only | Get Smart Group Membership by Id. |
jamf_Free · Read-only | Get Smart Group by Id. |
jamf_Free · Read-only | Get Static Group Membership by Id. |
jamf_Free · Read-only | Get Static Group by Id. |
jamf_Free · Read-only | Return the list of all Mobile Device Groups. |
jamf_Free · Read-only | Get Smart Groups. |
jamf_Free · Read-only | Get Static Groups. |
jamf_Pro · Write | Update a static group. |
jamf_Pro · Destructive | Update a smart group. |
Mobile Device Groups (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new mobile device group by ID. |
jamf_Pro · Destructive | Deletes a mobile device group by ID. |
jamf_Pro · Destructive | Deletes a mobile device group by name. |
jamf_Free · Read-only | Finds mobile device groups by ID. |
jamf_Free · Read-only | Finds mobile device groups by name. |
jamf_Free · Read-only | Finds all mobile device groups. |
jamf_Pro · Destructive | Updates an existing mobile device group by ID. |
jamf_Pro · Destructive | Updates an existing mobile device group by name. |
Mobile Device History (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Finds mobile device history by ID. |
jamf_Free · Read-only | finds a subset of data for a mobile device history. |
jamf_Free · Read-only | Finds mobile device history by wifi mac address. |
jamf_Free · Read-only | Finds a subset of data for mobile device history by wifi mac address. |
jamf_Free · Read-only | Finds mobile device history by name. |
jamf_Free · Read-only | Finds a subset of data for mobile device history by name. |
jamf_Free · Read-only | Finds mobile device history by serial number. |
jamf_Free · Read-only | Finds a subset of data for mobile device history by serial number. |
jamf_Free · Read-only | Finds mobile device history by UDID. |
jamf_Free · Read-only | Finds a subset of data for mobile device history by UDID. |
Mobile Device Invitations (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Creates a new mobile device invitation by id. |
jamf_Pro · Destructive | Creates a new mobile device invitation by invitation. |
jamf_Pro · Destructive | Deletes a mobile device invitation by id. |
jamf_Pro · Destructive | Deletes a mobile device invitation by invitation. |
jamf_Free · Read-only | Finds mobile device invitations by id. |
jamf_Free · Read-only | Finds mobile device invitations by invitation. |
jamf_Free · Read-only | Finds all mobile device invitations. |
Mobile Device Prestages
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create a Mobile Device Prestage. |
jamf_Pro · Write | Add an attachment to a Mobile Device Prestage. |
jamf_Pro · Write | Add Mobile Device Prestage history object notes. |
jamf_Pro · Write | Add Device Scope for a specific Mobile Device Prestage. |
jamf_Pro · Destructive | Delete a Mobile Device Prestage with the supplied id. |
jamf_Pro · Destructive | Remove an attachment for a Mobile Device Prestage. |
jamf_Pro · Destructive | Remove Device Scope for a specific Mobile Device Prestage. |
jamf_Free · Read-only | Retrieve a Mobile Device Prestage with the supplied id. |
jamf_Free · Read-only | Get sorted and paged Mobile Device Prestages. |
jamf_Free · Read-only | Get attachments for a Mobile Device Prestage. |
jamf_Free · Read-only | Get sorted and paged Mobile Device Prestage history objects. |
jamf_Free · Read-only | Get all Device Scope for all Mobile Device Prestages. |
jamf_Free · Read-only | Get Device Scope for a specific Mobile Device Prestage. |
jamf_Free · Read-only | Get all Prestage sync States for all prestages. |
jamf_Free · Read-only | Get all prestage sync states for a single prestage. |
jamf_Free · Read-only | Get the latest Sync State for a single Prestage. |
jamf_Pro · Destructive | Update a Mobile Device Prestage. |
jamf_Pro · Destructive | Replace Device Scope for a specific Mobile Device Prestage. |
Mobile Device Provisioning Profiles (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a mobile device provisioning profiles by id. |
jamf_Pro · Write | Creates a mobile device provisioning profiles by name. |
jamf_Pro · Write | Creates a mobile device provisioning profiles by uuid. |
jamf_Pro · Destructive | Deletes a mobile device provisioning profiles by id. |
jamf_Pro · Destructive | Deletes a mobile device provisioning profiles by name. |
jamf_Pro · Destructive | Deletes a mobile device provisioning profiles by uuid. |
jamf_Free · Read-only | Finds a mobile device provisioning profiles by id. |
jamf_Free · Read-only | Finds a mobile device provisioning profiles by name. |
jamf_Free · Read-only | Finds a mobile device provisioning profiles by uuid. |
jamf_Free · Read-only | Finds all mobile device provisioning profiles. |
jamf_Pro · Destructive | Updates an existing mobile device provisioning profiles by id. |
jamf_Pro · Destructive | Updates an existing mobile device provisioning profiles by name. |
jamf_Pro · Destructive | Updates an existing mobile device provisioning profiles by uuid. |
Mobile Devices
| Tool | What it does |
|---|---|
jamf_Pro · Write | Recalculate all smart groups for the given device id and then return count of smart groups that device fall into. |
jamf_Pro · Destructive | Erase a Mobile Device. |
jamf_Free · Read-only | Get Mobile Device. |
jamf_Free · Read-only | Get Mobile Device objects. |
jamf_Free · Read-only | Return paginated Mobile Device Inventory records. |
jamf_Free · Read-only | Get Mobile Device. |
jamf_Free · Read-only | Return paginated Mobile Device Inventory records of all paired devices for the device. |
jamf_Pro · Write | Update fields on a mobile device that are allowed to be modified by users. |
jamf_Pro · Destructive | Unmanage a Mobile Device. |
Mobile Devices (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new mobile device by ID. |
jamf_Pro · Destructive | Deletes a mobile device by ID. |
jamf_Pro · Destructive | Deletes a mobile device by Mac address. |
jamf_Pro · Destructive | Deletes a mobile device by name. |
jamf_Pro · Destructive | Deletes a mobile device by serial number. |
jamf_Pro · Destructive | Deletes a mobile device by UDID. |
jamf_Free · Read-only | Finds mobile devices by ID. |
jamf_Free · Read-only | Finds a subset of data for a mobile device. |
jamf_Free · Read-only | Finds mobile devices by Mac address. |
jamf_Free · Read-only | Finds a subset of data for mobile devices by Mac address. |
jamf_Free · Read-only | Searches for mobile devices that match the provided parameter. |
jamf_Free · Read-only | Finds mobile devices by name. |
jamf_Free · Read-only | Finds a subset of data for mobile devices by name. |
jamf_Free · Read-only | Finds mobile devices by serial number. |
jamf_Free · Read-only | Finds a subset of data for mobile devices by serial number. |
jamf_Free · Read-only | Finds mobile devices by UDID. |
jamf_Free · Read-only | Finds a subset of data for mobile devices by UDID. |
jamf_Free · Read-only | Finds all mobile devices. |
jamf_Pro · Destructive | Updates an existing mobile device by ID. |
jamf_Pro · Destructive | Updates an existing mobile device by Mac address. |
jamf_Pro · Destructive | Updates an existing mobile device by name. |
jamf_Pro · Destructive | Updates an existing mobile device by serial number. |
jamf_Pro · Destructive | Updates an existing mobile device by UDID. |
Personal Device Profiles (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a personal device profile by ID. |
jamf_Pro · Destructive | Deletes a personal device profile by ID. |
jamf_Pro · Destructive | Deletes a personal device profile by name. |
jamf_Free · Read-only | Finds personal device profile by ID. |
jamf_Free · Read-only | Finds a personal device profile by name. |
jamf_Free · Read-only | Finds all personal device profiles. |
jamf_Pro · Destructive | Updates a personal device profile by ID. |
jamf_Pro · Destructive | Updates a personal device profile by name. |
Smart Mobile Device Groups
| Tool | What it does |
|---|---|
jamf_Pro · Write | Recalculate a smart group for the given id then return the ids for the devices in the smart group. |
Allowed File Extensions (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new allowed file extension value by ID. |
jamf_Pro · Destructive | Deletes an allowed file extension value by ID. |
jamf_Free · Read-only | Finds an allowed file extension value by name. |
jamf_Free · Read-only | Finds an allowed file extension value by ID. |
jamf_Free · Read-only | Finds the allowed file extensions. |
App Request
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create Form Input Field record. |
jamf_Pro · Destructive | Remove specified Form Input Field record. |
jamf_Free · Read-only | Get specified Form Input Field object. |
jamf_Free · Read-only | Search for Form Input Fields. |
jamf_Free · Read-only | Get Applicastion Request Settings. |
jamf_Pro · Destructive | Replace all Form Input Fields. |
jamf_Pro · Destructive | Update specified Form Input Field object. |
jamf_Pro · Destructive | Update Application Request Settings. |
Cloud Distribution Point
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates the cloud distribution point. |
jamf_Pro · Destructive | Marks an in-progress upload to the cloud distribution point as failed. |
jamf_Pro · Write | Add specified cloud distribution point history object notes. |
jamf_Pro · Destructive | Updates the inventory data Jamf Pro holds for the configured cloud distribution point. |
jamf_Pro · Destructive | Delete cloud distribution point. |
jamf_Free · Read-only | Get the cloud distribution point Details. |
jamf_Free · Read-only | Get the cloud distribution point Inventory files details. |
jamf_Free · Read-only | Get cloud distribution point history details. |
jamf_Free · Read-only | Reads the result of the cloud distribution point connection test, which reports whether Jamf Pro can reach the configured content delivery network. |
jamf_Free · Read-only | Finds specific information for the currently configured cloud distribution point. |
jamf_Pro · Write | Update specific fields on a cloud distribution point. |
Deploy Package
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Deploys one or more packages to named computers with an MDM install command. |
Directory Bindings (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new directory binding by ID. |
jamf_Pro · Destructive | Deletes a directory binding by ID. |
jamf_Pro · Destructive | Deletes a directory binding by name. |
jamf_Free · Read-only | Finds directory bindings by ID. |
jamf_Free · Read-only | Finds directory bindings by name. |
jamf_Free · Read-only | Finds all directory bindings. |
jamf_Pro · Destructive | Updates an existing directory binding by ID. |
jamf_Pro · Destructive | Updates an existing directory binding by name. |
Disk Encryption Configurations (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new disk encryption configuration by ID. |
jamf_Pro · Destructive | Deletes a disk encryption configuration by ID. |
jamf_Pro · Destructive | Deletes a disk encryption configuration by name. |
jamf_Free · Read-only | Finds disk encryption configurations by ID. |
jamf_Free · Read-only | Finds disk encryption configurations by name. |
jamf_Free · Read-only | Finds all disk encryption configurations. |
jamf_Pro · Destructive | Updates an existing disk encryption configuration by ID. |
jamf_Pro · Destructive | Updates an existing disk encryption configuration by name. |
Distribution Points
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create distribution point. |
jamf_Pro · Write | Add specified distribution point History object notes. |
jamf_Pro · Destructive | Remove specified distribution point. |
jamf_Pro · Destructive | Deletes several distribution point records in one call. |
jamf_Free · Read-only | Get specified distribution point. |
jamf_Free · Read-only | Finds all Distribution Points. |
jamf_Free · Read-only | Get specified distribution point History object. |
jamf_Pro · Write | Update specified distribution point object. |
jamf_Pro · Destructive | Update specified distribution point object. |
Distribution Points (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new distribution point by ID. |
jamf_Pro · Destructive | Deletes a distribution point by ID. |
jamf_Pro · Destructive | Deletes a distribution point by name. |
jamf_Free · Read-only | Finds distribution points by ID. |
jamf_Free · Read-only | Finds distribution points by name. |
jamf_Free · Read-only | Finds all distribution points. |
jamf_Pro · Destructive | Updates an existing distribution point by ID. |
jamf_Pro · Destructive | Updates an existing distribution point by name. |
Dock Items
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create a DockItem. |
jamf_Pro · Destructive | Delete a DockItem at the specified id. |
jamf_Free · Read-only | Retrieve a full dockItem object. |
jamf_Pro · Destructive | Replace the dockItem at the id with the supplied information. |
Dock Items (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new dock item by ID. |
jamf_Pro · Destructive | Deletes a dock item by ID. |
jamf_Pro · Destructive | Deletes a dock item by name. |
jamf_Free · Read-only | Finds dock items by ID. |
jamf_Free · Read-only | Finds dock items by name. |
jamf_Free · Read-only | Finds all dock items. |
jamf_Pro · Destructive | Updates an existing dock item by ID. |
jamf_Pro · Destructive | Updates an existing dock item by name. |
Ebooks
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Get specified Ebook object. |
jamf_Free · Read-only | Get Ebook object. |
jamf_Free · Read-only | Get specified scope of Ebook object. |
eBooks (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Creates a new eBook record. |
jamf_Pro · Destructive | Deletes an ebook by ID. |
jamf_Pro · Destructive | Deletes an ebook by name. |
jamf_Free · Read-only | Finds ebooks by ID. |
jamf_Free · Read-only | Finds a subset of data for an ebook by ID. |
jamf_Free · Read-only | Finds ebooks by name. |
jamf_Free · Read-only | Finds a subset of data for ebooks by name. |
jamf_Free · Read-only | Finds all ebooks. |
jamf_Pro · Destructive | Updates an existing ebook by ID. |
jamf_Pro · Destructive | Updates an existing ebook by name. |
File Uploads (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Uploads a file attachment to a Jamf Pro record such as a computer, a mobile device, or a policy. |
Icon
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Uploads an icon image to Jamf Pro. |
jamf_Free · Read-only | Reads an icon record by ID. |
Jamf Cloud Distribution Service
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Creates a temporary upload record and returns the credentials needed to upload a file to the Jamf Cloud Distribution Service. |
jamf_Pro · Destructive | Refreshes the inventory and status of uploads in Jamf Pro, which is what makes an uploaded file deployable. |
jamf_Pro · Destructive | Renews the credentials needed to upload a file to the Jamf Cloud Distribution Service. |
jamf_Pro · Destructive | Deletes a file from the Jamf Cloud Distribution Service by name. |
jamf_Free · Read-only | Retrieves a time limited download URL for one file in the Jamf Cloud Distribution Service. |
jamf_Free · Read-only | Lists the files and file metadata held in the Jamf Cloud Distribution Service. |
Jamf Package
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Lists the installer packages Jamf publishes for one of its own applications, such as Jamf Connect or Jamf Protect. |
Licensed Software (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates new licensed software by ID. |
jamf_Pro · Destructive | Deletes licensed software by ID. |
jamf_Pro · Destructive | Deletes licensed software by name. |
jamf_Free · Read-only | Finds licensed software by ID. |
jamf_Free · Read-only | Finds licensed software by name. |
jamf_Free · Read-only | Finds all licensed software. |
jamf_Pro · Destructive | Updates existing licensed software by ID. |
jamf_Pro · Destructive | Updates an existing licensed software by name. |
Mac Applications (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Creates a new Mac application record. |
jamf_Pro · Destructive | Deletes a mac application by ID. |
jamf_Pro · Destructive | Deletes a mac application by name. |
jamf_Free · Read-only | Finds mac applications by ID. |
jamf_Free · Read-only | Finds a subset of date for a mac application by ID. |
jamf_Free · Read-only | Finds mac applications by name. |
jamf_Free · Read-only | Finds a subset of data for mac applications by name. |
jamf_Free · Read-only | Finds all mac applications. |
jamf_Pro · Destructive | Updates an existing mac application by ID. |
jamf_Pro · Destructive | Updates an existing mac application by name. |
macOS Configuration Profiles (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Creates a new macOS configuration profile. |
jamf_Pro · Destructive | Deletes a OS X configuration profile by ID. |
jamf_Pro · Destructive | Deletes a OS X configuration profile by name. |
jamf_Free · Read-only | Finds OS X configuration profiles by ID. |
jamf_Free · Read-only | Finds a subset of data for an OS X configuration profile. |
jamf_Free · Read-only | Finds OS X configuration profiles by name. |
jamf_Free · Read-only | Finds a subset of data for OS X configuration profiles by name. |
jamf_Free · Read-only | Finds all OS X configuration profiles. |
jamf_Pro · Destructive | Updates an existing OS X configuration profile by ID. |
jamf_Pro · Destructive | Updates an existing OS X configuration profile by name. |
Packages
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create package. |
jamf_Pro · Write | Add specified Package history object notes. |
jamf_Pro · Write | Attaches a manifest to a package record. |
jamf_Pro · Destructive | Deletes several package records in one call. |
jamf_Pro · Destructive | Remove specified package. |
jamf_Pro · Destructive | Deletes the manifest attached to a package record. |
jamf_Free · Read-only | Exports the package collection in the format you ask for. |
jamf_Free · Read-only | Exports the history of one package record in the format you ask for. |
jamf_Free · Read-only | Get specified Package object. |
jamf_Free · Read-only | Retrieve Packages. |
jamf_Free · Read-only | Get specified Package History object. |
jamf_Pro · Destructive | Update specified package object. |
jamf_Pro · Destructive | Uploads the installer file for an existing package record. |
Packages (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new package by ID. |
jamf_Pro · Destructive | Deletes a package by ID. |
jamf_Pro · Destructive | Deletes a package by name. |
jamf_Free · Read-only | Finds packages by ID. |
jamf_Free · Read-only | Finds packages by name. |
jamf_Free · Read-only | Finds all packages. |
jamf_Pro · Destructive | Updates an existing package by ID. |
jamf_Pro · Destructive | Updates an existing package by name. |
Policies (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Creates a new policy. |
jamf_Pro · Destructive | Deletes a policy by ID. |
jamf_Pro · Destructive | Deletes a policy by name. |
jamf_Free · Read-only | Finds all policies by category. |
jamf_Free · Read-only | Finds all policies by type. |
jamf_Free · Read-only | Finds policies by ID. |
jamf_Free · Read-only | Finds a subset of data for a policy. |
jamf_Free · Read-only | Finds policies by name. |
jamf_Free · Read-only | Finds a subset of data for policies by name. |
jamf_Free · Read-only | Finds all policies. |
jamf_Pro · Destructive | Updates an existing policy by ID. |
jamf_Pro · Destructive | Updates an existing policy by name. |
Policy Properties
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Get Policy Properties object. |
jamf_Pro · Destructive | Updates the Jamf Pro wide policy property defaults. |
Printers (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new printer by ID. |
jamf_Pro · Destructive | Deletes a printer by ID. |
jamf_Pro · Destructive | Deletes a printer by name. |
jamf_Free · Read-only | Finds printers by ID. |
jamf_Free · Read-only | Finds printers by name. |
jamf_Free · Read-only | Finds all printers. |
jamf_Pro · Destructive | Updates an existing printer by ID. |
jamf_Pro · Destructive | Updates an existing printer by name. |
Restricted Software (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Creates a new restricted software record. |
jamf_Pro · Destructive | Deletes a restricted software by ID. |
jamf_Pro · Destructive | Deletes a restricted software by name. |
jamf_Free · Read-only | Finds restricted software by ID. |
jamf_Free · Read-only | Finds restricted software by name. |
jamf_Free · Read-only | Finds all restricted software. |
jamf_Pro · Destructive | Updates an existing restricted software by ID. |
jamf_Pro · Destructive | Updates an existing restricted software by name. |
Scripts
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create a Script. |
jamf_Pro · Write | Add specified Script history object notes. |
jamf_Pro · Destructive | Delete a Script at the specified id. |
jamf_Free · Read-only | Retrieve a full script object. |
jamf_Free · Read-only | Search for sorted and paged Scripts. |
jamf_Free · Read-only | Downloads the contents of a script as a text file. |
jamf_Free · Read-only | Get specified Script history object. |
jamf_Pro · Destructive | Replace the script at the id with the supplied information. |
Scripts (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new script by ID. |
jamf_Pro · Destructive | Deletes a script by ID. |
jamf_Pro · Destructive | Deletes a script by name. |
jamf_Free · Read-only | Finds scripts by ID. |
jamf_Free · Read-only | Finds scripts by name. |
jamf_Free · Read-only | Finds all scripts. |
jamf_Pro · Destructive | Updates an existing script by ID. |
jamf_Pro · Destructive | Updates an existing script by name. |
Self Service
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Uploads a branding image for use in a Self Service branding configuration. |
jamf_Pro · Write | Create a Self Service iOS branding configuration with the supplied. |
jamf_Pro · Write | Create a Self Service macOS branding configuration with the supplied. |
jamf_Pro · Write | Add Self Service settings history notes. |
jamf_Pro · Destructive | Delete the Self Service iOS branding configuration indicated by the provided id. |
jamf_Pro · Destructive | Delete the Self Service macOS branding configuration indicated by the provided id. |
jamf_Free · Read-only | Read a single Self Service iOS branding configuration indicated by the provided id. |
jamf_Free · Read-only | Read a single Self Service macOS branding configuration indicated by the provided id. |
jamf_Free · Read-only | Search for sorted and paged iOS branding configurations. |
jamf_Free · Read-only | Search for sorted and paged macOS branding configurations. |
jamf_Free · Read-only | Get an object representation of Self Service settings. |
jamf_Free · Read-only | Get a page of Self Service settings history. |
jamf_Pro · Destructive | Update a Self Service iOS branding configuration with the supplied details. |
jamf_Pro · Destructive | Update a Self Service macOS branding configuration with the supplied details. |
jamf_Pro · Destructive | Put an object representation of Self Service settings. |
Self Service Plus
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Reports whether the Self Service Plus feature toggle is enabled on this Jamf Pro server. |
jamf_Free · Read-only | Get Self Service Plus settings. |
jamf_Pro · Destructive | Save Self Service Plus settings. |
Software Update Servers (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a new software update server by ID. |
jamf_Pro · Destructive | Deletes a software update server by ID. |
jamf_Pro · Destructive | Deletes a software update server by name. |
jamf_Free · Read-only | Finds software update servers by ID. |
jamf_Free · Read-only | Finds software update servers by name. |
jamf_Free · Read-only | Finds all software update servers. |
jamf_Pro · Destructive | Updates an existing software update server by ID. |
jamf_Pro · Destructive | Updates an existing software update server by name. |
Apple Push Notification Status
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Enable push notifications for all clients. |
jamf_Pro · Destructive | Enable push notifications for a single client. |
jamf_Free · Read-only | Search for clients with push notifications disabled. |
jamf_Free · Read-only | Get status of enable all clients request. |
Check In
| Tool | What it does |
|---|---|
jamf_Pro · Write | Add a Note to Client Check-In History. |
jamf_Free · Read-only | Get Client Check-In settings. |
jamf_Free · Read-only | Get Client Check-In history object. |
jamf_Pro · Destructive | Update Client Check-In object. |
Command Flush (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Flushes commands based on information specified in an XML file. |
jamf_Pro · Destructive | Flushes commands for devices. |
Declarative Device Management
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Retrieve a Status Item from the latest Status Report for a device. |
jamf_Free · Read-only | Retrieve the Status Items from the latest Status Report for a device. |
jamf_Pro · Destructive | Force a device DDM sync. |
Declarative Device Management Declarations
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Retrieve an existing declaration. |
Device Communication Settings
| Tool | What it does |
|---|---|
jamf_Pro · Write | Add Device Communication Settings history notes. |
jamf_Free · Read-only | Retrieves all settings for device communication. |
jamf_Free · Read-only | Get Device Communication settings history. |
jamf_Pro · Destructive | Update device communication settings. |
Device Enrollments
| Tool | What it does |
|---|---|
jamf_Pro · Write | Add Device Enrollment history object notes. |
jamf_Pro · Destructive | Create a Device Enrollment Instance with the supplied Token. |
jamf_Pro · Destructive | Delete a Device Enrollment Instance with the supplied id. |
jamf_Pro · Destructive | Disown devices from the given Device Enrollment Instance. |
jamf_Free · Read-only | Retrieve a Device Enrollment Instance with the supplied id. |
jamf_Free · Read-only | Read all sorted and paged Device Enrollment instances. |
jamf_Free · Read-only | Retrieve a list of Devices assigned to the supplied id. |
jamf_Free · Read-only | Get sorted and paged Device Enrollment history objects. |
jamf_Free · Read-only | Get all instance sync states for all Device Enrollment Instances. |
jamf_Free · Read-only | Get all instance sync states for a single Device Enrollment Instance. |
jamf_Free · Read-only | Get the latest sync state for a single Device Enrollment Instance. |
jamf_Pro · Destructive | Update a Device Enrollment Instance with the supplied id. |
jamf_Pro · Destructive | Update a Device Enrollment Instance with the supplied Token. |
Enrollment
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Add the configured LDAP group for User-Initiated Enrollment. |
jamf_Pro · Destructive | Configure Access Management settings. |
jamf_Pro · Write | Add Enrollment history object notes. |
jamf_Pro · Destructive | Delete an LDAP group's access to user initiated Enrollment. |
jamf_Pro · Destructive | Delete the Enrollment messaging for a language. |
jamf_Pro · Destructive | Delete multiple configured languages from User-Initiated Enrollment settings. |
jamf_Free · Read-only | Export enrollment history collection. |
jamf_Free · Read-only | Retrieve the configured LDAP groups configured for User-Initiated Enrollment. |
jamf_Free · Read-only | Retrieve the Enrollment messaging for a language. |
jamf_Free · Read-only | Get Enrollment object and Re-enrollment settings. |
jamf_Free · Read-only | Retrieve the configured LDAP groups configured for User-Initiated Enrollment. |
jamf_Free · Read-only | Get Access Management settings. |
jamf_Free · Read-only | Retrieve the list of languages and corresponding ISO 639-1 Codes but only those not already added to Enrollment. |
jamf_Free · Read-only | Get sorted and paged Enrollment history object. |
jamf_Free · Read-only | Retrieve the list of languages and corresponding ISO 639-1 Codes. |
jamf_Free · Read-only | Get an array of the language codes that have Enrollment messaging. |
jamf_Pro · Destructive | Update Enrollment object. |
jamf_Pro · Destructive | Modify the configured LDAP groups configured for User-Initiated Enrollment. |
jamf_Pro · Destructive | Edit Enrollment messaging for a language. |
Enrollment Customization
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create an LDAP Panel for a single Enrollment Customization. |
jamf_Free · Read-only | Parse the given string as markdown text and return Html output. |
jamf_Pro · Write | Create an SSO Panel for a single Enrollment Customization. |
jamf_Pro · Write | Create a Text Panel for a single Enrollment Customization. |
jamf_Pro · Destructive | Delete a single Panel from an Enrollment Customization. |
jamf_Pro · Destructive | Delete an LDAP single panel from an Enrollment Customization. |
jamf_Pro · Destructive | Delete a single SSO Panel from an Enrollment Customization. |
jamf_Pro · Destructive | Delete a Text single Panel from an Enrollment Customization. |
jamf_Free · Read-only | Get a single Panel for a single Enrollment Customization. |
jamf_Free · Read-only | Get a single LDAP panel for a single Enrollment Customization. |
jamf_Free · Read-only | Get a single SSO Panel for a single Enrollment Customization. |
jamf_Free · Read-only | Get a single Text Panel for a single Enrollment Customization. |
jamf_Free · Read-only | Get all Panels for single Enrollment Customization. |
jamf_Free · Read-only | Get the markdown output of a single Text Panel for a single Enrollment. |
jamf_Pro · Destructive | Update a single LDAP Panel for a single Enrollment Customization. |
jamf_Pro · Destructive | Update a single SSO Panel for a single Enrollment Customization. |
jamf_Pro · Destructive | Update a single Text Panel for a single Enrollment Customization. |
Enrollment Customizations
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create an Enrollment Customization. |
jamf_Pro · Write | Add Enrollment Customization history object notes. |
jamf_Pro · Destructive | Upload an image. |
jamf_Pro · Destructive | Delete an Enrollment Customization with the supplied id. |
jamf_Free · Read-only | Retrieve an Enrollment Customization with the supplied id. |
jamf_Free · Read-only | Retrieve sorted and paged Enrollment Customizations. |
jamf_Free · Read-only | Get sorted and paged Enrollment Customization history objects. |
jamf_Free · Read-only | Retrieve the list of Prestages using this Enrollment Customization. |
jamf_Pro · Destructive | Update an Enrollment Customization. |
Inventory Preload
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Create a new Inventory Preload record using JSON or CSV. |
jamf_Pro · Destructive | Create one or more new Inventory Preload records using CSV. |
jamf_Free · Read-only | Validate a given CSV file. |
jamf_Pro · Write | Add Inventory Preload history object notes. |
jamf_Pro · Write | Add Inventory Preload history object notes. |
jamf_Pro · Write | Create a new Inventory Preload record using JSON. |
jamf_Pro · Destructive | Delete all Inventory Preload records. |
jamf_Free · Read-only | Validate a given CSV file. |
jamf_Pro · Destructive | Delete all Inventory Preload records. |
jamf_Pro · Destructive | Delete an Inventory Preload record. |
jamf_Pro · Destructive | Delete an Inventory Preload record. |
jamf_Free · Read-only | Export a collection of inventory preload records. |
jamf_Free · Read-only | Get an Inventory Preload record. |
jamf_Free · Read-only | Get an Inventory Preload record. |
jamf_Free · Read-only | Return all Inventory Preload records. |
jamf_Free · Read-only | Download all Inventory Preload records. |
jamf_Free · Read-only | Download the Inventory Preload CSV template. |
jamf_Free · Read-only | Retrieve a list of extension attribute columns. |
jamf_Free · Read-only | Get Inventory Preload history entries. |
jamf_Free · Read-only | Return all Inventory Preload records. |
jamf_Pro · Destructive | Update an Inventory Preload record. |
jamf_Pro · Destructive | Update an Inventory Preload record. |
Log Flush (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Flushes a log specified in an XML file. |
jamf_Pro · Destructive | Flushes a single log for a given interval. |
jamf_Pro · Destructive | Flushes all logs for a given interval. |
Macos Managed Software Updates
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Send MacOs Managed Software Updates. |
jamf_Free · Read-only | Retrieve available MacOs Managed Software Updates. |
Managed Software Updates
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Create a Managed Software Update Plan. |
jamf_Pro · Destructive | Create Managed Software Update Plans for a Group. |
jamf_Pro · Destructive | Force stops any ongoing or stalled feature-toggle processes. |
jamf_Free · Read-only | Retrieve a Managed Software Update Plan. |
jamf_Free · Read-only | Retrieve Managed Software Update Plans for a Group. |
jamf_Free · Read-only | Retrieve Managed Software Update Statuses for Computers. |
jamf_Free · Read-only | Retrieve Managed Software Update Statuses for Mobile Devices. |
jamf_Free · Read-only | Retrieve Managed Software Update Statuses for Computer Groups. |
jamf_Free · Read-only | Retrieve Managed Software Update Statuses for Mobile Device Groups. |
jamf_Free · Read-only | Retrieve available macOS and iOS Managed Software Updates. |
jamf_Free · Read-only | Retrieve Managed Software Update Plans. |
jamf_Free · Read-only | Retrieve all Declarations associated with a Managed Software Update Plan. |
jamf_Free · Read-only | Retrieve a Managed Software Update Plan Event Store. |
jamf_Free · Read-only | Retrieve current value of the Feature Toggle. |
jamf_Free · Read-only | Retrieves background status of the Feature Toggle. |
jamf_Free · Read-only | Retrieve Managed Software Update Statuses. |
jamf_Pro · Destructive | Updates Feature Toggle Value. |
MDM Commands
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Send blank push notifications to a list of client management IDs. |
jamf_Pro · Destructive | Post a command for creation and queuing. |
jamf_Pro · Destructive | Renew MDM Profile. |
jamf_Free · Read-only | Get information about mdm commands made by Jamf Pro. |
MDM Profile Renewal
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Delete MDM renewal strategies for a client management ID. |
jamf_Free · Read-only | Get device common details for a client management ID. |
jamf_Free · Read-only | Get MDM renewal errors and strategies for a client management ID. |
jamf_Pro · Write | Update device common details (partial update). |
Onboarding
| Tool | What it does |
|---|---|
jamf_Pro · Write | Add Onboarding history object notes. |
jamf_Free · Read-only | Export history object collection in specified format for Onboarding. |
jamf_Free · Read-only | Get the current onboarding settings configuration. |
jamf_Free · Read-only | Retrieves a list of applications that are eligible to be used in an onboarding configuration. |
jamf_Free · Read-only | Retrieves a list of configuration profiles that are eligible to be used in an onboarding configuration. |
jamf_Free · Read-only | Retrieves a list of policies that are eligible to be used in an onboarding configuration. |
jamf_Free · Read-only | Get Onboarding history object. |
jamf_Pro · Destructive | Update the onboarding configuration. |
Patch Available Titles (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Finds all available title from a source by ID. |
Patch External Sources (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create a new patch external source by ID. |
jamf_Pro · Write | Create a new patch external source by name. |
jamf_Pro · Destructive | Deletes a patch external source by ID. |
jamf_Free · Read-only | Finds a patch external source by ID. |
jamf_Free · Read-only | Finds the first patch external source with the name provided. |
jamf_Free · Read-only | Finds all patch external sources. |
jamf_Pro · Destructive | Updates a patch external source by ID. |
jamf_Pro · Destructive | Updates a patch external source by name. |
Patch Internal Sources (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Finds a patch internal source by ID. |
jamf_Free · Read-only | Finds the first patch internal source with the name provided. |
jamf_Free · Read-only | Finds all patch internal sources. |
Patch Management (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a patch software title (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".). |
jamf_Pro · Destructive | Deletes a Patch Software Title by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".). |
jamf_Pro · Destructive | Deletes a Patch Software Title by name (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".). |
jamf_Free · Read-only | Finds patches by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".). |
jamf_Free · Read-only | Display computers on a specific version (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}/definitions".). |
jamf_Free · Read-only | Finds the first patch with the name provided (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".). |
jamf_Free · Read-only | Display computers on a specific version (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".). |
jamf_Free · Read-only | Finds all patches (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations". |
jamf_Pro · Destructive | Updates a Patch Software Title by ID (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations/{id}".). |
jamf_Pro · Destructive | Updates a Patch Software Title by name (Deprecated - Please transition use to Jamf Pro API endpoint "/v2/patch-software-title-configurations".). |
Patch Management Accept Disclaimer
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Accept Patch Management disclaimer. |
Patch Policies
| Tool | What it does |
|---|---|
jamf_Pro · Write | Add a patch policy to the dashboard. |
jamf_Pro · Destructive | Send retry attempts for all devices. |
jamf_Pro · Destructive | Remove a patch policy from the dashboard. |
jamf_Free · Read-only | Retrieves a single Patch Policy Log. |
jamf_Free · Read-only | Retrieve Patch Policies. |
jamf_Free · Read-only | Return whether or not the requested patch policy is on the dashboard. |
jamf_Free · Read-only | Retrieve Patch Policy Logs. |
jamf_Free · Read-only | Return attempt details for a specific log. |
jamf_Free · Read-only | Return the count of the Patch Policy Logs for the patch policy id that are eligible for a retry attempt. |
jamf_Free · Read-only | Retrieve Patch Policies. |
jamf_Pro · Destructive | Send retry attempts for specific devices. |
Patch Policies (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Create a new patch policy associated with a patch software title configuration ID. |
jamf_Pro · Destructive | Deletes a patch policy by ID. |
jamf_Free · Read-only | Finds a patch policy by ID. |
jamf_Free · Read-only | Display subsets of information for a patch policy. |
jamf_Free · Read-only | Finds all patch policies by patch software title configuration ID (Deprecated). |
jamf_Free · Read-only | Finds all patch policies. |
jamf_Pro · Destructive | Updates an existing patch policy by ID. |
Patch Reports (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Finds patch reports by patch software title ID. |
jamf_Free · Read-only | Display computers for a specific version of a patch report. |
Patch Software Title Configurations
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create Patch Software Title Configurations. |
jamf_Pro · Write | Add a software title configuration to the dashboard. |
jamf_Pro · Write | Add Patch Software Title Configuration history object notes. |
jamf_Pro · Destructive | Delete Patch Software Title Configurations with the supplied id. |
jamf_Pro · Destructive | Remove a software title configuration from the dashboard. |
jamf_Free · Read-only | Retrieve Patch Software Title Configurations with the supplied id. |
jamf_Free · Read-only | Retrieve Software Title Extension Attributes with the supplied id. |
jamf_Free · Read-only | Returns patch versions. |
jamf_Free · Read-only | Retrieve Patch Software Title Configurations. |
jamf_Free · Read-only | Return whether or not the requested software title configuration is on the dashboard. |
jamf_Free · Read-only | Retrieve Patch Software Title Definitions with the supplied id. |
jamf_Free · Read-only | Retrieve list of Patch Software Title Configuration Dependencies. |
jamf_Free · Read-only | Export Patch Reporting Data. |
jamf_Free · Read-only | Get specified Patch Software Title Configuration history object. |
jamf_Free · Read-only | Retrieve Patch Software Title Configuration Patch Report. |
jamf_Free · Read-only | Return Active Patch Summary. |
jamf_Pro · Write | Update Patch Software Title Configurations. |
Patch Software Titles (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates new patch software title by ID. |
jamf_Pro · Destructive | Deletes a patch software title by ID. |
jamf_Free · Read-only | Finds a patch software titles by ID. |
jamf_Free · Read-only | Finds all patch software titles. |
jamf_Pro · Destructive | Updates a patch software title by ID. |
Reenrollment
| Tool | What it does |
|---|---|
jamf_Pro · Write | Add specified Re-enrollment history object notes. |
jamf_Free · Read-only | Export reenrollment history collection. |
jamf_Free · Read-only | Get Re-enrollment object. |
jamf_Free · Read-only | Get Re-enrollment history object. |
jamf_Pro · Destructive | Update the Re-enrollment object. |
Return To Service
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create a Return to Service Configuration. |
jamf_Pro · Destructive | Delete a Return To Service Configuration with the supplied id. |
jamf_Free · Read-only | Retrieve a Return to Service Configuration with the supplied id. |
jamf_Free · Read-only | Get all Return to Service Configurations. |
jamf_Pro · Destructive | Update a Return to Service Configuration. |
Service Discovery Enrollment
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Get service discovery well-known settings for all organizations. |
jamf_Pro · Destructive | Update service discovery well-known settings. |
Account Groups
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Get one Jamf Pro account group by ID, including its privilege set and the accounts that belong to it. |
jamf_Free · Read-only | List the Jamf Pro account groups, the groups that carry privilege sets for Jamf Pro administrators. |
Account Preferences
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Get the Jamf Pro interface preferences of the account whose API credentials this connection uses, such as language, date format and results per page. |
jamf_Pro · Write | Update the Jamf Pro interface preferences of the account whose API credentials this connection uses. |
Accounts
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Create a Jamf Pro user account. |
jamf_Pro · Destructive | Delete a Jamf Pro user account by ID. |
jamf_Free · Read-only | Get one Jamf Pro user account by ID. |
jamf_Free · Read-only | List the Jamf Pro user accounts through the current Jamf Pro API. |
jamf_Pro · Destructive | Update a Jamf Pro user account by ID. |
Accounts (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Create a Jamf Pro account group at the given ID. |
jamf_Pro · Destructive | Create a Jamf Pro administrator account at the given ID. |
jamf_Pro · Destructive | Delete a Jamf Pro account group by ID. |
jamf_Pro · Destructive | Delete a Jamf Pro account group by name. |
jamf_Pro · Destructive | Delete a Jamf Pro administrator account by ID. |
jamf_Pro · Destructive | Delete a Jamf Pro administrator account by user name. |
jamf_Free · Read-only | Get one Jamf Pro account group by ID, including its privilege set and members. |
jamf_Free · Read-only | Get one Jamf Pro account group by name, including its privilege set and members. |
jamf_Free · Read-only | Get one Jamf Pro administrator account by ID, including its access level, privilege set and site assignment. |
jamf_Free · Read-only | Get one Jamf Pro administrator account by user name, including its access level, privilege set and site assignment. |
jamf_Free · Read-only | List every Jamf Pro administrator account and account group. |
jamf_Pro · Destructive | Replace a Jamf Pro account group by ID. |
jamf_Pro · Destructive | Replace a Jamf Pro account group by name. |
jamf_Pro · Destructive | Replace a Jamf Pro administrator account by ID. |
jamf_Pro · Destructive | Replace a Jamf Pro administrator account by user name. |
Api Integrations
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Create a Jamf Pro API integration. |
jamf_Pro · Destructive | Mint a new client secret for a Jamf Pro API integration. |
jamf_Pro · Destructive | Delete a Jamf Pro API integration by ID. |
jamf_Free · Read-only | Get one Jamf Pro API integration by ID, including the API roles it holds and its access token lifetime. |
jamf_Free · Read-only | List the Jamf Pro API integrations, the API clients that hold client credentials for machine access to this Jamf Pro server. |
jamf_Pro · Destructive | Update a Jamf Pro API integration by ID. |
Api Role Privileges
| Tool | What it does |
|---|---|
jamf_Free · Read-only | List every privilege name a Jamf Pro API role can grant. |
jamf_Free · Read-only | Search the Jamf Pro API role privilege names. |
Api Roles
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Create a Jamf Pro API role from a list of privilege names. |
jamf_Pro · Destructive | Delete a Jamf Pro API role by ID. |
jamf_Free · Read-only | Get one Jamf Pro API role by ID, including every privilege it grants. |
jamf_Free · Read-only | List the Jamf Pro API roles, the named privilege sets that API integrations hold. |
jamf_Pro · Destructive | Update a Jamf Pro API role by ID. |
Apple Device Users Session Tokens
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Get the Account Driven User Enrollment session token settings, which control how long an enrollment session token stays valid. |
jamf_Pro · Destructive | Replace the Account Driven User Enrollment session token settings. |
Certificate Authorities
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Create an AD CS certificate authority configuration and start its renewal monitor. |
jamf_Pro · Write | Add a note to an AD CS certificate authority history. |
jamf_Pro · Write | Validate the file format of an AD CS server certificate. |
jamf_Pro · Write | Validate the file format and password of an AD CS client certificate. |
jamf_Pro · Destructive | Create a DigiCert Trust Lifecycle Manager configuration and start its renewal monitor. |
jamf_Pro · Write | Validate the file format and password of a DigiCert client certificate. |
jamf_Pro · Destructive | Create a Venafi certificate authority configuration. |
jamf_Pro · Write | Add a note to a Venafi certificate authority history. |
jamf_Pro · Destructive | Regenerate the certificate Jamf Pro presents to a Jamf Pro PKI Proxy Server. |
jamf_Pro · Destructive | Upload the PKI Proxy Server public key that Jamf Pro will trust for TLS validation. |
jamf_Pro · Destructive | Delete an AD CS certificate authority configuration by ID. |
jamf_Pro · Destructive | Delete a DigiCert Trust Lifecycle Manager configuration by ID. |
jamf_Pro · Destructive | Delete a Venafi certificate authority configuration by ID. |
jamf_Pro · Destructive | Remove the PKI Proxy Server public key Jamf Pro trusts. |
jamf_Free · Read-only | Get one AD CS certificate authority configuration by ID. |
jamf_Free · Read-only | Get the X.509 details of one certificate authority by ID. |
jamf_Free · Read-only | Get the DigiCert Trust Lifecycle Manager configuration by ID. |
jamf_Free · Read-only | Get one Venafi certificate authority configuration by ID. |
jamf_Free · Read-only | List the configuration profiles that depend on one AD CS certificate authority. |
jamf_Free · Read-only | Get the change history and notes recorded against one AD CS certificate authority configuration. |
jamf_Free · Read-only | Get the X.509 details of the certificate authority Jamf Pro currently issues device certificates from. |
jamf_Free · Read-only | Download the active certificate authority in PEM format. |
jamf_Free · Read-only | Download one certificate authority in PEM format by ID. |
jamf_Free · Read-only | Test the connection between Jamf Pro and DigiCert Trust Lifecycle Manager. |
jamf_Free · Read-only | List the configuration profiles that depend on a DigiCert Trust Lifecycle Manager configuration. |
jamf_Free · Read-only | Check whether the DigiCert account Jamf Pro uses holds the permissions needed to deploy certificates. |
jamf_Free · Read-only | Test the connection between Jamf Pro and a Jamf Pro PKI Proxy Server. |
jamf_Free · Read-only | List the configuration profiles that use one Venafi certificate authority. |
jamf_Free · Read-only | Get the change history and notes recorded against one Venafi certificate authority configuration. |
jamf_Free · Read-only | Download the certificate Jamf Pro presents to a Jamf Pro PKI Proxy Server. |
jamf_Free · Read-only | Download the PKI Proxy Server public key that Jamf Pro trusts. |
jamf_Pro · Write | Update an AD CS certificate authority configuration. |
jamf_Pro · Write | Update a DigiCert Trust Lifecycle Manager configuration. |
jamf_Pro · Destructive | Update a Venafi certificate authority configuration by ID. |
Cloud Identity Providers
| Tool | What it does |
|---|---|
jamf_Pro · Write | Add a note to a cloud identity provider history. |
jamf_Pro · Write | Run a test group lookup against a configured cloud identity provider to confirm its search base and mappings. |
jamf_Pro · Write | Run a test user lookup against a configured cloud identity provider to confirm its search base and mappings. |
jamf_Pro · Write | Run a test membership lookup against a configured cloud identity provider to confirm that group membership resolves. |
jamf_Free · Read-only | Export the cloud identity provider list as a report. |
jamf_Free · Read-only | Get one cloud identity provider configuration by ID. |
jamf_Free · Read-only | List every cloud identity provider configured in Jamf Pro. |
jamf_Free · Read-only | Get the change history and notes recorded against one cloud identity provider. |
Cloud LDAP
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Create a cloud identity provider configuration. |
jamf_Pro · Destructive | Delete a cloud identity provider configuration by ID. |
jamf_Free · Read-only | Get one cloud identity provider configuration by ID through the LDAP surface, including server settings and keystore details. |
jamf_Free · Read-only | Get bind connection pool statistics for a cloud identity provider. |
jamf_Free · Read-only | Get search connection pool statistics for a cloud identity provider. |
jamf_Free · Read-only | Test the connection between Jamf Pro and a cloud identity provider. |
jamf_Free · Read-only | Get the default attribute mappings Jamf Pro suggests for a cloud identity provider type. |
jamf_Free · Read-only | Get the default server configuration Jamf Pro suggests for a cloud identity provider type. |
jamf_Free · Read-only | Get the attribute mappings of one cloud identity provider, the fields Jamf Pro reads for user and group lookups. |
jamf_Pro · Destructive | Update a cloud identity provider configuration by ID. |
jamf_Pro · Destructive | Replace the attribute mappings of a cloud identity provider. |
Conditional Access
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Get the conditional access compliance state Jamf Pro reports for one Mac. |
jamf_Free · Read-only | Get the conditional access compliance state Jamf Pro reports for one mobile device. |
jamf_Free · Read-only | Get whether the device compliance feature is turned on for this Jamf Pro server. |
Infrastructure Manager (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Get one Jamf Infrastructure Manager by ID. |
jamf_Free · Read-only | List the Jamf Infrastructure Managers registered with this Jamf Pro server. |
jamf_Pro · Destructive | Replace a Jamf Infrastructure Manager record by ID. |
Jamf Cloud Services Connection
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Delete the Jamf Cloud Services token exchange. |
jamf_Free · Read-only | Get the Jamf Cloud Services tenant ID of this Jamf Pro server. |
jamf_Free · Read-only | Get the status of the Jamf Cloud Services token exchange, which lets Jamf Pro authenticate to Jamf hosted services. |
Jamf Pro User (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Get basic Jamf Pro server information and the privileges of the account whose credentials this connection uses. |
JSON Web Token Configurations (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Create a JSON Web Token configuration. |
jamf_Pro · Destructive | Delete a JSON Web Token configuration by ID. |
jamf_Free · Read-only | Get one JSON Web Token configuration by ID. |
jamf_Free · Read-only | List the JSON Web Token configurations, the signing keys Jamf Pro trusts for token based integrations. |
jamf_Pro · Destructive | Replace a JSON Web Token configuration by ID. |
Last Login
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Get the date of the most recent Jamf Pro login event. |
LDAP
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Search the configured directory access groups by name. |
jamf_Free · Read-only | List the LDAP servers configured in Jamf Pro. |
jamf_Free · Read-only | List every directory Jamf Pro can query, both LDAP servers and cloud identity providers. |
LDAP (Classic)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Get the attribute mappings of an on-premises LDAP configuration by ID. |
LDAP Keystore
| Tool | What it does |
|---|---|
jamf_Pro · Write | Validate a keystore for a secure cloud identity provider connection. |
LDAP Servers (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Create an LDAP server configuration. |
jamf_Pro · Destructive | Delete an LDAP server configuration by ID. |
jamf_Pro · Destructive | Delete an LDAP server configuration by name. |
jamf_Free · Read-only | Get one LDAP server configuration by ID, including its connection and mapping settings. |
jamf_Free · Read-only | Look up groups on an LDAP server addressed by ID. |
jamf_Free · Read-only | Check whether a user belongs to a group on an LDAP server addressed by ID. |
jamf_Free · Read-only | Look up users on an LDAP server addressed by ID. |
jamf_Free · Read-only | Get one LDAP server configuration by name, including its connection and mapping settings. |
jamf_Free · Read-only | Look up groups on an LDAP server addressed by name. |
jamf_Free · Read-only | Check whether a user belongs to a group on an LDAP server addressed by name. |
jamf_Free · Read-only | Look up users on an LDAP server addressed by name. |
jamf_Free · Read-only | List the LDAP servers configured in Jamf Pro, with their IDs and names. |
jamf_Pro · Destructive | Replace an LDAP server configuration by ID. |
jamf_Pro · Destructive | Replace an LDAP server configuration by name. |
Machine-to-Machine Authentication
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Get the machine to machine tenant ID of this Jamf Pro server. |
Microsoft Entra Integration
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Create an Azure cloud identity provider configuration. |
jamf_Pro · Destructive | Delete a cloud identity provider configuration by ID. |
jamf_Free · Read-only | Get one Azure cloud identity provider configuration by ID, including its server settings and attribute mappings. |
jamf_Free · Read-only | Get the default Azure attribute mappings Jamf Pro suggests. |
jamf_Free · Read-only | Get the default Azure server configuration Jamf Pro suggests. |
jamf_Pro · Destructive | Update an Azure cloud identity provider configuration by ID. |
Network Segments (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create a network segment. |
jamf_Pro · Destructive | Delete a network segment by ID. |
jamf_Pro · Destructive | Delete a network segment by name. |
jamf_Free · Read-only | Get one network segment by ID, including its IP range and the building and department it assigns. |
jamf_Free · Read-only | Get one network segment by name, including its IP range and the building and department it assigns. |
jamf_Free · Read-only | List the network segments, the IP ranges Jamf Pro uses to scope policies and to set a device building and department. |
jamf_Pro · Destructive | Replace a network segment by ID. |
jamf_Pro · Destructive | Replace a network segment by name. |
OpenID Connect
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Generate a new keystore for signing OpenID Connect messages. |
jamf_Pro · Write | Get the redirect URL for an OpenID Connect sign in from an email address. |
jamf_Free · Read-only | Get the URL that sends a user straight to the identity provider for OpenID Connect sign in. |
jamf_Free · Read-only | Get the OpenID Connect features this Jamf Pro server advertises publicly. |
jamf_Free · Read-only | Get the public key of the keystore Jamf Pro uses to sign OpenID Connect messages, as a JSON Web Token. |
Removable MAC Addresses (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Add a MAC address for Jamf Pro to ignore during inventory. |
jamf_Pro · Destructive | Delete an ignored MAC address by ID. |
jamf_Pro · Destructive | Delete an ignored MAC address by name. |
jamf_Free · Read-only | Get one ignored MAC address by ID. |
jamf_Free · Read-only | Get one ignored MAC address by name. |
jamf_Free · Read-only | List the MAC addresses Jamf Pro ignores during inventory, normally shared adapters and docks. |
jamf_Pro · Destructive | Replace an ignored MAC address record by ID. |
jamf_Pro · Destructive | Replace an ignored MAC address record by name. |
Single Sign-On
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Have Jamf Pro generate a new certificate and start signing single sign on requests with it. |
jamf_Pro · Write | Parse a certificate file to report its type and the keys needed to upload it. |
jamf_Pro · Destructive | Regenerate the single sign on failover URL. |
jamf_Pro · Write | Add a note to the single sign on history. |
jamf_Pro · Destructive | Delete the certificate configured for single sign on. |
jamf_Pro · Destructive | Turn single sign on off. |
jamf_Free · Read-only | Get the current single sign on configuration of this Jamf Pro server. |
jamf_Free · Read-only | Get the certificate Jamf Pro uses to sign single sign on requests. |
jamf_Free · Read-only | Download the single sign on signing certificate. |
jamf_Free · Read-only | List the enrollment customizations that use single sign on. |
jamf_Free · Read-only | Get the current single sign on failover settings, including the failover URL that bypasses the identity provider. |
jamf_Free · Read-only | Get the change history and notes recorded against the single sign on configuration. |
jamf_Free · Read-only | Download the SAML metadata file for this Jamf Pro server. |
jamf_Pro · Destructive | Replace the single sign on configuration. |
jamf_Pro · Destructive | Replace the certificate Jamf Pro uses to sign single sign on requests. |
Sites (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Create a Jamf Pro site. |
jamf_Pro · Destructive | Delete a Jamf Pro site by ID. |
jamf_Pro · Destructive | Delete a Jamf Pro site by name. |
jamf_Free · Read-only | Get one Jamf Pro site by ID. |
jamf_Free · Read-only | Get one Jamf Pro site by name. |
jamf_Free · Read-only | List the Jamf Pro sites, the boundaries that partition objects and administrator access. |
jamf_Pro · Destructive | Replace a Jamf Pro site by ID. |
jamf_Pro · Destructive | Replace a Jamf Pro site by name. |
Software License Agreement
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Accept the Jamf software license and services agreement on this server. |
jamf_Free · Read-only | Get whether the Jamf software license and services agreement has been accepted on this server. |
Supervision Identities
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Create a supervision identity. |
jamf_Pro · Destructive | Delete a supervision identity by ID. |
jamf_Free · Read-only | Get one supervision identity by ID. |
jamf_Free · Read-only | List the supervision identities, the signing identities Apple Configurator uses to supervise devices. |
jamf_Pro · Destructive | Update a supervision identity by ID. |
jamf_Pro · Destructive | Upload a supervision identity p12 file. |
User Sessions
| Tool | What it does |
|---|---|
jamf_Free · Read-only | List the administrator sessions currently signed in to Jamf Pro. |
jamf_Free · Read-only | Get the number of administrator sessions currently signed in to Jamf Pro. |
Advanced User Content Searches
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a saved advanced user content search over the apps and eBooks assigned to users. |
jamf_Pro · Destructive | Deletes a saved advanced user content search by its ID. |
jamf_Free · Read-only | Returns one saved advanced user content search by its ID, with its criteria and the columns it displays. |
jamf_Free · Read-only | Lists the saved advanced user content searches. |
jamf_Pro · Destructive | Replaces a saved advanced user content search by its ID. |
Advanced User Searches (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a saved advanced user search. |
jamf_Pro · Destructive | Deletes a saved advanced user search by its numeric ID. |
jamf_Pro · Destructive | Deletes a saved advanced user search by its exact name. |
jamf_Free · Read-only | Returns one saved advanced user search by its numeric ID, with its criteria and the columns it displays. |
jamf_Free · Read-only | Returns one saved advanced user search by its exact name. |
jamf_Free · Read-only | Lists the saved advanced user searches. |
jamf_Pro · Destructive | Replaces a saved advanced user search by its numeric ID. |
jamf_Pro · Destructive | Replaces a saved advanced user search by its exact name. |
Buildings
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a building. |
jamf_Pro · Write | Adds a note to a building's change history. |
jamf_Pro · Destructive | Deletes one building by its ID. |
jamf_Pro · Destructive | Deletes several buildings at once, by ID. |
jamf_Free · Read-only | Exports the building list as CSV text rather than JSON. |
jamf_Free · Read-only | Exports one building's change history as CSV text rather than JSON. |
jamf_Free · Read-only | Returns one building by its ID, with its street address. |
jamf_Free · Read-only | Lists the buildings defined in Jamf Pro. |
jamf_Free · Read-only | Returns the change history of one building: who changed it, when, and the notes recorded against it. |
jamf_Pro · Destructive | Replaces a building by its ID. |
Buildings (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a building. |
jamf_Pro · Destructive | Deletes one building by its numeric ID. |
jamf_Pro · Destructive | Deletes one building by its exact name. |
jamf_Free · Read-only | Returns one building by its numeric ID. |
jamf_Free · Read-only | Returns one building by its exact name. |
jamf_Free · Read-only | Lists the buildings defined in Jamf Pro. |
jamf_Pro · Destructive | Replaces a building by its numeric ID. |
jamf_Pro · Destructive | Replaces a building by its exact name. |
Categories
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a category. |
jamf_Pro · Write | Adds a note to a category's change history. |
jamf_Pro · Destructive | Deletes one category by its ID. |
jamf_Pro · Destructive | Deletes several categories at once, by ID. |
jamf_Free · Read-only | Returns one category by its ID, with its display priority. |
jamf_Free · Read-only | Lists the categories defined in Jamf Pro. |
jamf_Free · Read-only | Returns the change history of one category: who changed it, when, and the notes recorded against it. |
jamf_Pro · Destructive | Replaces a category by its ID. |
Categories (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a category. |
jamf_Pro · Destructive | Deletes one category by its numeric ID. |
jamf_Pro · Destructive | Deletes one category by its exact name. |
jamf_Free · Read-only | Returns one category by its numeric ID, with its display priority. |
jamf_Free · Read-only | Returns one category by its exact name. |
jamf_Free · Read-only | Lists the categories defined in Jamf Pro. |
jamf_Pro · Destructive | Replaces a category by its numeric ID. |
jamf_Pro · Destructive | Replaces a category by its exact name. |
Classes (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates an Apple Classroom class. |
jamf_Pro · Destructive | Deletes a class by its numeric ID. |
jamf_Pro · Destructive | Deletes a class by its exact name. |
jamf_Free · Read-only | Returns one class by its numeric ID, with its teachers, its students and the devices in it. |
jamf_Free · Read-only | Returns one class by its exact name. |
jamf_Free · Read-only | Lists the classes defined in Jamf Pro. |
jamf_Pro · Destructive | Replaces a class by its numeric ID. |
jamf_Pro · Destructive | Replaces a class by its exact name. |
Current User
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Changes the Jamf Pro password of the account the request authenticates as, and needs the current password as well as the new one. |
jamf_Pro · Write | Updates values in the session this connection is using, such as the site it is scoped to. |
jamf_Pro · Destructive | Removes one saved interface preference of the account this connection authenticates as. |
jamf_Free · Read-only | Returns one saved interface preference of the account this connection authenticates as, by its key. |
jamf_Free · Read-only | Returns the settings behind one saved interface preference of the account this connection authenticates as, by its key. |
jamf_Free · Read-only | Returns the Jamf Pro administrator accounts defined on the server. |
jamf_Pro · Destructive | Replaces one saved interface preference of the account this connection authenticates as. |
Departments
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a department. |
jamf_Pro · Write | Adds a note to a department's change history. |
jamf_Pro · Destructive | Deletes one department by its ID. |
jamf_Pro · Destructive | Deletes several departments at once, by ID. |
jamf_Free · Read-only | Returns one department by its ID. |
jamf_Free · Read-only | Lists the departments defined in Jamf Pro. |
jamf_Free · Read-only | Returns the change history of one department: who changed it, when, and the notes recorded against it. |
jamf_Pro · Destructive | Replaces a department by its ID. |
Departments (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a department. |
jamf_Pro · Destructive | Deletes one department by its numeric ID. |
jamf_Pro · Destructive | Deletes one department by its exact name. |
jamf_Free · Read-only | Returns one department by its numeric ID. |
jamf_Free · Read-only | Returns one department by its exact name. |
jamf_Free · Read-only | Lists the departments defined in Jamf Pro. |
jamf_Pro · Destructive | Replaces a department by its numeric ID. |
jamf_Pro · Destructive | Replaces a department by its exact name. |
Groups
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Deletes a computer or mobile device group by its platform UUID. |
jamf_Free · Read-only | Returns one computer or mobile device group by its platform UUID, with its type and whether it is smart. |
jamf_Free · Read-only | Lists every computer group and every mobile device group in one place, each keyed by a platform UUID rather than by the numeric ID the per-type endpoints use. |
jamf_Pro · Write | Updates a computer or mobile device group by its platform UUID, merging the fields you send into the record. |
iBeacons (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates an iBeacon region. |
jamf_Pro · Destructive | Deletes an iBeacon region by its numeric ID. |
jamf_Pro · Destructive | Deletes an iBeacon region by its exact name. |
jamf_Free · Read-only | Returns one iBeacon region by its numeric ID, with the beacon identifiers that define it. |
jamf_Free · Read-only | Returns one iBeacon region by its exact name. |
jamf_Free · Read-only | Lists the iBeacon regions defined in Jamf Pro. |
jamf_Pro · Destructive | Replaces an iBeacon region by its numeric ID. |
jamf_Pro · Destructive | Replaces an iBeacon region by its exact name. |
Parent App
| Tool | What it does |
|---|---|
jamf_Pro · Write | Adds a note to the Jamf Parent settings change history. |
jamf_Free · Read-only | Returns the current Jamf Parent settings: whether the app is enabled, and what a guardian is allowed to do with a student's school-issued device. |
jamf_Free · Read-only | Returns the change history of the Jamf Parent settings: who changed them, when, and the version that resulted. |
jamf_Pro · Destructive | Replaces the Jamf Parent settings. |
Peripheral Types (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a peripheral type. |
jamf_Pro · Destructive | Deletes a peripheral type by its numeric ID. |
jamf_Free · Read-only | Returns one peripheral type by its numeric ID, with the fields it defines. |
jamf_Free · Read-only | Lists the peripheral types defined in Jamf Pro. |
jamf_Pro · Destructive | Replaces a peripheral type by its numeric ID. |
Peripherals (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a peripheral record. |
jamf_Pro · Destructive | Deletes a peripheral record by its numeric ID. |
jamf_Free · Read-only | Returns one peripheral record by its numeric ID, whole. |
jamf_Free · Read-only | Returns one section of a peripheral record instead of the whole thing. |
jamf_Free · Read-only | Lists the peripheral records in inventory. |
jamf_Pro · Destructive | Replaces a peripheral record by its numeric ID. |
Saved Searches (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Returns one saved search by its numeric ID. |
jamf_Free · Read-only | Returns one saved search by its exact name. |
jamf_Free · Read-only | Lists the saved searches on the server. |
Sites
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Lists the sites defined in Jamf Pro. |
jamf_Free · Read-only | Lists the objects that belong to one site, each with its type. |
Smart User Groups
| Tool | What it does |
|---|---|
jamf_Pro · Write | Recalculates one smart user group and returns the IDs of the users that now match it. |
Static User Groups
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Returns one static user group by its ID, with the users in it. |
jamf_Free · Read-only | Lists the static user groups. |
Teacher App
| Tool | What it does |
|---|---|
jamf_Pro · Write | Adds a note to the Jamf Teacher settings change history. |
jamf_Free · Read-only | Returns the current Jamf Teacher settings: whether the app is enabled, and what a teacher is allowed to do with a student's device during class. |
jamf_Free · Read-only | Returns the change history of the Jamf Teacher settings: who changed them, when, and the version that resulted. |
jamf_Pro · Destructive | Replaces the Jamf Teacher settings. |
User Extension Attributes (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a user extension attribute, adding the custom field to every user record. |
jamf_Pro · Destructive | Deletes a user extension attribute by its numeric ID. |
jamf_Pro · Destructive | Deletes a user extension attribute by its exact name. |
jamf_Free · Read-only | Returns one user extension attribute by its numeric ID, with its data type and its input method. |
jamf_Free · Read-only | Returns one user extension attribute by its exact name. |
jamf_Free · Read-only | Lists the user extension attributes. |
jamf_Pro · Destructive | Replaces a user extension attribute by its numeric ID. |
jamf_Pro · Destructive | Replaces a user extension attribute by its exact name. |
User Groups (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a user group. |
jamf_Pro · Destructive | Deletes a user group by its numeric ID. |
jamf_Pro · Destructive | Deletes a user group by its exact name. |
jamf_Free · Read-only | Returns one user group by its numeric ID, with its members and, for a smart group, its criteria. |
jamf_Free · Read-only | Returns one user group by its exact name. |
jamf_Free · Read-only | Lists the user groups. |
jamf_Pro · Destructive | Replaces a user group by its numeric ID. |
jamf_Pro · Destructive | Replaces a user group by its exact name. |
Users
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates an inventory user. |
jamf_Pro · Write | Recalculates the smart user groups one user belongs to and returns how many now match. |
jamf_Pro · Destructive | Deletes an inventory user by ID. |
jamf_Free · Read-only | Returns one inventory user by ID, with the devices and the content assigned to them. |
jamf_Free · Read-only | Lists the inventory users: the people that devices and licenses are assigned to. |
jamf_Pro · Destructive | Replaces an inventory user by ID. |
Users (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates an inventory user. |
jamf_Pro · Destructive | Deletes an inventory user by their email address. |
jamf_Pro · Destructive | Deletes an inventory user by their numeric ID. |
jamf_Pro · Destructive | Deletes an inventory user by their exact user name. |
jamf_Free · Read-only | Returns one inventory user by their email address. |
jamf_Free · Read-only | Returns one inventory user by their numeric ID. |
jamf_Free · Read-only | Returns one inventory user by their exact user name. |
jamf_Free · Read-only | Lists the inventory users. |
jamf_Pro · Destructive | Replaces an inventory user by their email address. |
jamf_Pro · Destructive | Replaces an inventory user by their numeric ID. |
jamf_Pro · Destructive | Replaces an inventory user by their exact user name. |
Volume Purchasing Accounts (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Registers a legacy Volume Purchase Program account, which carries the Apple content token for the licenses bought under it. |
jamf_Pro · Destructive | Deletes a legacy Volume Purchase Program account by its numeric ID. |
jamf_Free · Read-only | Returns one legacy Volume Purchase Program account by its numeric ID. |
jamf_Free · Read-only | Lists the legacy Volume Purchase Program accounts. |
jamf_Pro · Destructive | Replaces a legacy Volume Purchase Program account by its numeric ID, content token included. |
Volume Purchasing Assignments (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Creates a Volume Purchase Program assignment, which hands app and book licenses to the users and groups in its scope. |
jamf_Pro · Destructive | Deletes a Volume Purchase Program assignment by its numeric ID. |
jamf_Free · Read-only | Returns one Volume Purchase Program assignment by its numeric ID, with the content it covers and who it is scoped to. |
jamf_Free · Read-only | Lists the Volume Purchase Program assignments: which apps and books are handed to which users and groups. |
jamf_Pro · Destructive | Replaces a Volume Purchase Program assignment by its numeric ID. |
Volume Purchasing Invitations (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Creates a Volume Purchase Program invitation and sends it to the users in its scope. |
jamf_Pro · Destructive | Deletes a Volume Purchase Program invitation by its numeric ID. |
jamf_Free · Read-only | Returns one Volume Purchase Program invitation by its numeric ID, whole. |
jamf_Free · Read-only | Returns one section of a Volume Purchase Program invitation instead of the whole record. |
jamf_Free · Read-only | Lists the Volume Purchase Program invitations: the requests sent to users asking them to accept managed app and book distribution. |
jamf_Pro · Destructive | Replaces a Volume Purchase Program invitation by its numeric ID. |
Volume Purchasing Locations
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Registers a Volume Purchasing location from an Apple Business Manager or Apple School Manager content token. |
jamf_Pro · Write | Adds a note to a Volume Purchasing location's change history. |
jamf_Pro · Destructive | Reclaims the licenses a Volume Purchasing location has handed out. |
jamf_Pro · Destructive | Revokes the licenses a Volume Purchasing location has issued. |
jamf_Pro · Destructive | Deletes a Volume Purchasing location by its ID. |
jamf_Free · Read-only | Returns one Volume Purchasing location by its ID, with its Apple ID, its country and its token expiry date. |
jamf_Free · Read-only | Lists the Volume Purchasing locations. |
jamf_Free · Read-only | Lists the apps and books bought under one Volume Purchasing location, with how many licenses each one has and how many are in use. |
jamf_Free · Read-only | Returns the change history of one Volume Purchasing location: who changed it, when, and the notes recorded against it. |
jamf_Pro · Destructive | Updates a Volume Purchasing location, merging the fields you send into the record. |
Volume Purchasing Subscriptions
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a Volume Purchasing subscription. |
jamf_Pro · Write | Adds a note to a Volume Purchasing subscription's change history. |
jamf_Pro · Destructive | Deletes a Volume Purchasing subscription by its ID. |
jamf_Free · Read-only | Returns one Volume Purchasing subscription by its ID, with the events it watches and the people it notifies. |
jamf_Free · Read-only | Lists the Volume Purchasing subscriptions. |
jamf_Free · Read-only | Returns the change history of one Volume Purchasing subscription: who changed it, when, and the notes recorded against it. |
jamf_Pro · Destructive | Replaces a Volume Purchasing subscription by its ID. |
Activation Code
| Tool | What it does |
|---|---|
jamf_Pro · Write | Adds a note to the activation code history. |
jamf_Free · Read-only | Exports the activation code history as a file rather than a page of records. |
jamf_Free · Read-only | Returns the change history for the activation code: who changed it, when, and any note they left. |
jamf_Pro · Write | Changes only the registered organization name and leaves the activation code untouched. |
jamf_Pro · Destructive | Replaces the Jamf Pro activation code and the organization name it is registered to. |
Activation Code (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Reads the Jamf Pro activation code and the organization name it is registered to. |
jamf_Pro · Destructive | Replaces the Jamf Pro activation code and the registered organization name. |
App Store Country Codes
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Returns the App Store country codes Jamf Pro accepts, for use anywhere a storefront or region has to be named. |
Apple GSX Connection
| Tool | What it does |
|---|---|
jamf_Pro · Write | Adds a note to the Apple Global Service Exchange connection history. |
jamf_Free · Read-only | Reads the Apple Global Service Exchange connection settings Jamf Pro uses to look up warranty and purchase data for Mac hardware. |
jamf_Free · Read-only | Returns the change history for the Apple Global Service Exchange connection: who changed it, when, and any note they left. |
jamf_Pro · Write | Merges the fields you supply into the Apple Global Service Exchange connection and leaves every other field as it was. |
jamf_Free · Read-only | Tests the stored Apple Global Service Exchange connection and reports whether Jamf Pro can reach Apple with it. |
jamf_Pro · Destructive | Replaces the whole Apple Global Service Exchange connection record. |
Cache Settings
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Reads the Jamf Pro cache configuration: the cache type, its expiration and, for an external cache, the host it uses. |
jamf_Pro · Destructive | Replaces the whole cache configuration. |
Cloud Information
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Reports whether this Jamf Pro is Jamf Cloud hosted and which cloud services it can reach. |
Dashboard
| Tool | What it does |
|---|---|
jamf_Pro · Write | Pins an object to the Jamf Pro dashboard or unpins it, chosen by the enabled flag in the body. |
jamf_Free · Read-only | Returns everything pinned to the Jamf Pro dashboard: which policies, groups and patch titles an administrator sees on sign-in. |
Environment Type
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Returns the cloud services environment type for this server, which decides which cloud integrations are available. |
GSX Connection (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Reads the stored Apple Global Service Exchange connection settings used to look up warranty and purchase data for Mac hardware. |
jamf_Pro · Destructive | Replaces the whole Apple Global Service Exchange connection record, including the Apple ID and certificate settings. |
Health Check
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Returns the Jamf Pro API status. |
Health Status
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Returns request acceptance ratios for this Jamf Pro node, which is how you tell a server that is refusing load from one that is down. |
Healthcare Listener (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Reads one Healthcare Listener connection by its numeric Jamf Pro ID. |
jamf_Free · Read-only | Lists the Healthcare Listener connections, which receive HL7 messages from a clinical system so Jamf Pro can act on patient-room device events. |
jamf_Pro · Destructive | Replaces one Healthcare Listener connection by ID. |
Healthcare Listener Rules (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Write | Creates a Healthcare Listener rule at the ID given in the path. |
jamf_Free · Read-only | Reads one Healthcare Listener rule by its numeric Jamf Pro ID. |
jamf_Free · Read-only | Lists the Healthcare Listener rules that decide what Jamf Pro does when an HL7 message arrives. |
jamf_Pro · Destructive | Replaces one Healthcare Listener rule by ID. |
Impact Alert Notification Settings
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Reads the settings that decide when Jamf Pro warns an administrator that a change is about to affect a large number of devices. |
jamf_Pro · Destructive | Replaces the impact alert settings wholesale. |
Inventory Information
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Returns fleet counts in one call: managed and unmanaged computers and mobile devices, and the number of users. |
Jamf Connect
| Tool | What it does |
|---|---|
jamf_Pro · Write | Adds a note to the Jamf Connect settings history. |
jamf_Free · Read-only | Returns the Jamf Connect settings this API account can see. |
jamf_Free · Read-only | Lists the configuration profiles linked to Jamf Connect, with the version each one deploys and its update setting. |
jamf_Free · Read-only | Lists the per-device install tasks for one Jamf Connect configuration profile, with the status of each. |
jamf_Free · Read-only | Returns the change history for the Jamf Connect settings: who changed them, when, and any note they left. |
jamf_Pro · Destructive | Requests a retry of the Jamf Connect install tasks whose IDs you supply, which pushes a real installation to those Macs at their next check-in. |
jamf_Pro · Destructive | Replaces how the Jamf Connect app is updated on every computer in scope of one configuration profile. |
Jamf Management Framework
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Redeploys the Jamf management framework to one computer, identified by its Jamf Pro computer ID. |
Jamf Pro Information
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Returns the headline facts about the server in one call: version, whether it is cloud hosted, and which optional features are turned on. |
Jamf Pro Server Url
| Tool | What it does |
|---|---|
jamf_Pro · Write | Adds a note to the Jamf Pro server URL history. |
jamf_Free · Read-only | Reads the server URL that Jamf Pro hands out to enrolled devices, which is the address every managed Mac and mobile device checks in to. |
jamf_Free · Read-only | Returns the change history for the Jamf Pro server URL, which is where to look first when devices stop checking in after a migration. |
jamf_Pro · Destructive | Replaces the server URL that enrolled devices check in to. |
Jamf Pro Version
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Returns the Jamf Pro version string. |
Jamf Protect
| Tool | What it does |
|---|---|
jamf_Pro · Write | Adds a note to the Jamf Protect settings history. |
jamf_Pro · Destructive | Registers a Jamf Protect tenant with Jamf Pro using a Protect URL, client ID and password. |
jamf_Pro · Destructive | Removes the Jamf Protect API registration entirely. |
jamf_Free · Read-only | Returns the Jamf Protect integration settings, including whether Jamf Pro is registered with a Protect tenant and which URL it talks to. |
jamf_Free · Read-only | Lists the per-device install tasks for one Jamf Protect configuration profile, with the status of each. |
jamf_Free · Read-only | Returns the change history for the Jamf Protect integration settings: who changed them, when, and any note they left. |
jamf_Free · Read-only | Lists the Jamf Protect plans already synced into Jamf Pro, with the configuration profile each one is tied to. |
jamf_Pro · Destructive | Requests a retry of the Jamf Protect install tasks whose IDs you supply, which pushes a real installation to those Macs at their next check-in. |
jamf_Pro · Destructive | Pulls the current plans from Jamf Protect and overwrites the copies held in Jamf Pro. |
jamf_Pro · Destructive | Replaces the Jamf Protect integration settings wholesale. |
Jamf Remote Assist
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Exports the Jamf Remote Assist session history as a file rather than a page of records, which is the right tool for a remote access audit covering a long period. |
jamf_Free · Read-only | Reads one Jamf Remote Assist session history item by its ID. |
jamf_Free · Read-only | Returns the history of Jamf Remote Assist screen sharing sessions: which administrator connected to which device and when. |
Locales
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Returns the locales Jamf Pro accepts, for use anywhere a language has to be named. |
Log Flushing
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Queues a task that permanently deletes Jamf Pro log entries older than the interval you name. |
jamf_Pro · Destructive | Cancels a queued log flushing task by its ID. |
jamf_Free · Read-only | Reads one log flushing task by its ID, including whether it has finished. |
jamf_Free · Read-only | Reads the log flushing schedule: which Jamf Pro logs are trimmed automatically and how much history is kept. |
jamf_Free · Read-only | Lists the log flushing tasks currently queued or running, with the status of each. |
Login Customization
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Reads the disclaimer shown on the Jamf Pro sign-in page: its heading, body text and whether it is enabled. |
jamf_Pro · Destructive | Replaces the sign-in page disclaimer wholesale. |
Notifications
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Dismisses one Jamf Pro console notification, identified by its type and ID from jamf_list_notifications. |
jamf_Free · Read-only | Returns the alerts Jamf Pro is showing the current API account for its site, such as an expiring certificate or a failing integration. |
Preview Endpoints
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Creates a TeamViewer remote administration configuration from a script token you supply, which gives Jamf Pro administrators the ability to take remote control of managed Macs. |
jamf_Pro · Destructive | Closes an open TeamViewer remote control session, which disconnects the administrator from the device immediately and ends whatever work is in progress on that screen. |
jamf_Pro · Destructive | Resends the TeamViewer session notification to the person using the device, which prompts them again to accept a remote control session. |
jamf_Pro · Destructive | Opens a TeamViewer remote control session against the device named in the body, which lets an administrator see and control that Mac. |
jamf_Pro · Destructive | Permanently deletes one TeamViewer remote administration configuration. |
jamf_Free · Read-only | Reads one TeamViewer remote administration configuration by ID, including whether it is enabled and how long a session may last. |
jamf_Free · Read-only | Reads one TeamViewer remote control session by ID. |
jamf_Free · Read-only | Returns a paged list of computers from the Jamf Pro preview API, with names and IDs only. |
jamf_Free · Read-only | Reports the live state of one TeamViewer remote control session, which is how you tell a session that is still connected to a device from one that has ended. |
jamf_Free · Read-only | Lists the TeamViewer remote control sessions for one configuration, with the device and state of each. |
jamf_Free · Read-only | Reports whether one TeamViewer remote administration configuration is currently connected and usable, which separates a configuration that is merely present from one that works. |
jamf_Free · Read-only | Lists every remote administration configuration on this server, which is how you find out whether remote control of managed Macs is set up and by which vendor. |
jamf_Pro · Destructive | Updates a TeamViewer remote administration configuration, merging only the fields you supply. |
Scheduler
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Lists every background job the Jamf Pro scheduler runs, by job key. |
jamf_Free · Read-only | Lists the triggers for one scheduler job, with the last and next fire times, so you can tell a job that is misconfigured from one that is merely overdue. |
jamf_Free · Read-only | Returns a summary of the Jamf Pro scheduler in one call, which is the fastest way to see whether background work is running at all before you page through individual jobs. |
Settings
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Issues a new Tomcat SSL certificate from the Jamf Pro built-in certificate authority and installs it on the server. |
jamf_Free · Read-only | Reads the global policy properties object, which holds server-wide defaults applied to policies. |
jamf_Pro · Destructive | Replaces the global policy properties object wholesale. |
SMTP Server
| Tool | What it does |
|---|---|
jamf_Pro · Write | Adds a note to the SMTP server settings history. |
jamf_Free · Read-only | Reads the SMTP server settings Jamf Pro uses to send mail: host, port, sender address and authentication type, never the password. |
jamf_Free · Read-only | Returns the SMTP authentication types this Jamf Pro accepts, which is what you check before choosing a value for jamf_update_smtp_server. |
jamf_Free · Read-only | Returns the change history for the SMTP server settings: who changed them, when, and any note they left. |
jamf_Pro · Destructive | Sends a real test message through the configured SMTP server to the recipientEmail address in the body. |
jamf_Pro · Destructive | Replaces the whole SMTP server record. |
SMTP Server (Classic API)
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Reads the stored SMTP server settings Jamf Pro uses to send mail: host, port, sender address and authentication type, never the password. |
jamf_Pro · Destructive | Replaces the whole SMTP server record. |
Startup Status
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Reports how far a restarting Jamf Pro has got through startup, including any database migration in progress. |
System
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Supplies the database password to a Jamf Pro server that is stalled during startup waiting for it. |
jamf_Pro · Destructive | Performs first-run setup of a brand new Jamf Pro server for Jamf Platform, the tenanted variant of the bring-up in jamf_initialize_system. |
jamf_Pro · Destructive | Performs first-run setup of a brand new Jamf Pro server: activation code, administrator account and the initial system settings. |
Time Zones
| Tool | What it does |
|---|---|
jamf_Free · Read-only | Returns the time zones Jamf Pro accepts, for use anywhere a schedule or a maintenance window has to be named. |
Webhooks (Classic API)
| Tool | What it does |
|---|---|
jamf_Pro · Destructive | Creates a webhook that streams Jamf Pro events to the URL in the XML body, optionally with a username and password Jamf Pro will send to that host. |
jamf_Pro · Destructive | Permanently deletes one webhook by ID. |
jamf_Pro · Destructive | Permanently deletes one webhook by display name. |
jamf_Free · Read-only | Reads one webhook by its numeric Jamf Pro ID, including the URL it posts to. |
jamf_Free · Read-only | Reads one webhook by its display name, including the URL it posts to. |
jamf_Free · Read-only | Lists every webhook Jamf Pro sends events to, with its destination URL, event type and enabled state. |
jamf_Pro · Destructive | Replaces one webhook by ID, destination URL and credentials included. |
jamf_Pro · Destructive | Replaces one webhook by display name, destination URL and credentials included. |
More in Connector guides
Connect Acronis Cyber Protect CloudConnect Action1Connect AddigyConnect AlertOpsStill need help? Ask the team