Before you start
- An Iru API token with MCP turned on and permissions that cover the calls below (recipe 1).
- The Mac's Blueprint has Parameters turned on. Parameters are built-in settings that manage Mac computers.
Prompt for your agent
Find the Mac named [device name or serial number] in Iru with GET /api/v1/devices and show me its name and serial number. Then call GET /api/v1/devices/{device_id}/status and GET /api/v1/devices/{device_id}/parameters. List every parameter whose status is ERROR, with its name, category and subcategory. For any parameter that comes back as an ID with no name, match it to a name on the Blueprint Parameter IDs page of docs.iru.com. Tell me which field you used for each ID, since I want to check it.
Steps
Find the Mac
Have the agent find the Mac by name or serial number and show you the device record before it goes further.
GET/api/v1/devicesSource: Iru API: List Devices
Pull the device status
The status call returns the device's parameters and its library items. Parameter statuses are ERROR for an audit failure, INCOMPATIBLE, PASS, PENDING for a parameter that hasn't run yet, REMEDIATED and WARNING for a muted alert.
GET/api/v1/devices/{device_id}/statusSource: Iru API: Get Device Status
List the failing parameters
The parameters call applies to Mac only. Each parameter in the response example carries a
status, anitem_id, aname, acategoryand asubcategory. Keep the ones with the ERROR status, since that value marks an audit failure.GET/api/v1/devices/{device_id}/parametersSource: Iru API: Get Device Parameters
Match IDs to names
The API identifies a Parameter by its ID, and the web app shows its name. The Blueprint Parameter IDs page lists each ID with its name, category and subcategory, so search that page for the ID.
Source: Blueprint Parameter IDs
Check it worked
- Every ID the agent reports appears on the Blueprint Parameter IDs page with the same name.
Common pitfalls
- The parameters call is Mac only. Use the status call for other platforms and expect library items there too.
- A WARNING status is a muted alert, not an audit failure, so it won't show up in an ERROR filter.
- PENDING means the parameter hasn't run on the device yet. It isn't a failure.
FAQ
Which API call lists a Mac's parameters?
GET /api/v1/devices/{device_id}/parameters returns each parameter with its status, name, category and subcategory. It applies to Mac only.
What does the ERROR status mean for a parameter?
ERROR means an audit failure. The other values are INCOMPATIBLE, PASS, PENDING, REMEDIATED and WARNING, which is a muted alert.
How do I turn a parameter ID into a name?
Search the Blueprint Parameter IDs page on docs.iru.com. It lists each ID with its name, category and subcategory.
Does the parameters call cover Windows?
No. The parameters call applies to Mac only, and the Blueprint Parameter IDs page applies to Mac computers.