Inventory Management¶
Tools for comprehensive computer inventory retrieval and search capabilities in Jamf Pro.
Get Computer Inventory¶
Retrieve detailed computer inventory information by serial number.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
str |
Yes |
The serial number of the computer to retrieve |
Example Response
{
"general": {
"id": 123,
"name": "John's MacBook Pro",
"serial_number": "ABC123456",
"udid": "12345678-1234-1234-1234-123456789012",
"model": "MacBook Pro (16-inch, 2023)",
"model_identifier": "Mac15,6",
"last_check_in": "2024-01-15T10:30:00Z"
},
"hardware": {
"make": "Apple",
"model": "MacBook Pro",
"processor": "Apple M3 Max",
"processor_speed_mhz": 3500,
"total_ram_mb": 32768,
"battery_capacity": 95
},
"operating_system": {
"name": "macOS",
"version": "14.2.1",
"build": "23C71"
},
"storage": {
"disks": [{
"device": "disk1s1",
"model": "Apple SSD",
"size_mb": 524288,
"available_mb": 262144,
"percentage_used": 50
}]
},
"applications": [{
"name": "Google Chrome",
"version": "120.0.6099.129",
"bundle_id": "com.google.Chrome"
}]
}
Usage Examples¶
Get Computer History¶
Retrieve computer history including policy logs, management commands, and user activity.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
int | str |
Yes |
Computer JSS ID |
Example Response
{
"computer_id": 123,
"general": {
"name": "John's MacBook Pro",
"serial_number": "ABC123456"
},
"policy_logs": [{
"policy_id": 45,
"policy_name": "Install Chrome",
"status": "Completed",
"date_completed": "2024-01-15T09:00:00Z",
"username": "john.doe"
}],
"commands": [{
"command": "Update Inventory",
"status": "Completed",
"issued": "2024-01-15T08:00:00Z",
"completed": "2024-01-15T08:01:00Z"
}],
"user_location_history": [{
"username": "john.doe",
"full_name": "John Doe",
"email": "john.doe@company.com",
"department": "Engineering",
"building": "HQ",
"date_assigned": "2023-06-01T00:00:00Z"
}],
"computer_usage_logs": [{
"event": "Login",
"username": "john.doe",
"date": "2024-01-15T08:30:00Z"
}]
}
Usage Examples¶
Related Tools¶
Current inventory and configuration details
View all available policies
Search Computers¶
Search for computers using various criteria including name, serial number, or other attributes.
Parameter |
Type |
Required |
Description |
|---|---|---|---|
|
str |
No |
Search term (name or serial) |
|
str |
No |
Results per page (defaults to 100) |
|
list[str] |
No |
Inventory sections to include |
Example Response
[
{
"id": 123,
"name": "John's MacBook Pro",
"serial_number": "ABC123456",
"udid": "12345678-1234-1234-1234-123456789012",
"model": "MacBook Pro",
"os_version": "14.2.1",
"last_check_in": "2024-01-15T10:30:00Z",
"managed": true,
"supervised": false
},
{
"id": 124,
"name": "Jane's MacBook Air",
"serial_number": "XYZ789012",
"model": "MacBook Air",
"os_version": "14.2.1",
"last_check_in": "2024-01-15T09:15:00Z",
"managed": true,
"supervised": true
}
]
Usage Examples¶
Related Tools¶
Detailed information for specific computers
Pre-configured computer groups
Inventory Sections Reference¶
Available Inventory Sections
Section |
Description |
Key Data |
|---|---|---|
GENERAL |
Basic computer information |
Name, serial, model, UDID |
DISK_ENCRYPTION |
FileVault status |
Encryption state, recovery key |
PURCHASING |
Purchase and warranty info |
PO number, warranty expiration |
APPLICATIONS |
Installed applications |
App names, versions, bundle IDs |
STORAGE |
Disk usage details |
Capacity, available space |
USER_AND_LOCATION |
Assignment information |
User, department, building |
CONFIGURATION_PROFILES |
Installed profiles |
Profile names, payloads |
HARDWARE |
Hardware specifications |
CPU, RAM, battery |
SECURITY |
Security settings |
SIP, Gatekeeper, Firewall |
OPERATING_SYSTEM |
OS details |
Version, build, kernel |
EXTENSION_ATTRIBUTES |
Custom attributes |
Organization-specific data |
GROUP_MEMBERSHIPS |
Group assignments |
Smart and static groups |
Best Practices¶
Check last_check_in timestamps to assess data currency before making decisions.
Request only needed inventory sections to improve performance and reduce data transfer.
Remember that Jamf Pro updates inventory on device check-in, not in real-time.
Use specific identifiers when possible rather than broad searches for better performance.