Deprecation of Classic API Computer Inventory Endpoints

Overview

This article describes the deprecation of the endpoints used to obtain macOS inventory data using the Classic API, beginning in version 11.15.0 of Jamf Pro, as well as recommendations on how to update your tools or applications to support these changes.

History

Jamf introduced the computers Classic API endpoints for obtaining macOS inventory data more than a decade ago and since that time thousands of API consumers have interacted with these endpoints. Beginning in Jamf Pro v10.39.0, Jamf introduced the computer-inventory endpoints as part of the Jamf Pro API, featuring support for sorting, filtering and pagination.

Deprecation Timeline

Beginning with Jamf Pro version 11.15.0 the computers endpoints will be moved to a deprecated state. Jamf is committed to minimizing the disruption created by this change and will provide a 1-year period of continued support for the computers endpoints used to obtain macOS inventory data from the Classic API. No additional development will take place for these endpoints and any new fields added to a computer object within Jamf Pro will require the use of the Jamf Pro API to obtain these data points.

Migration Resources

Overview

The computers endpoints in the Classic API require that API consumers iterate over every device individually. Although a similar approach could be implemented with the Return all sections of a computer endpoint in the Jamf Pro API, we recommend the use of the Return paginated Computer Inventory records endpoint, which supports pagination, filtering and sorting.

This endpoint which returns paginated results also supports the use of the section query parameter, allowing for more granular control over which data points are returned for a device record. If no value is specified for the section query parameter, the API will default to returning only the GENERAL section. Review the API reference documentation to ensure that you specify the values of sections required by your application. An example curl command for providing data from all sections can be found below:

curl -X 'GET' \
  'https://yourserver.jamfcloud.com/api/v1/computers-inventory?section=GENERAL&section=DISK_ENCRYPTION&section=PURCHASING&section=APPLICATIONS&section=STORAGE&section=USER_AND_LOCATION&section=CONFIGURATION_PROFILES&section=PRINTERS&section=SERVICES&section=HARDWARE&section=LOCAL_USER_ACCOUNTS&section=CERTIFICATES&section=ATTACHMENTS&section=PLUGINS&section=PACKAGE_RECEIPTS&section=FONTS&section=SECURITY&section=OPERATING_SYSTEM&section=LICENSED_SOFTWARE&section=IBEACONS&section=SOFTWARE_UPDATES&section=EXTENSION_ATTRIBUTES&section=CONTENT_CACHING&section=GROUP_MEMBERSHIPS&page=0&page-size=100&sort=general.name%3Aasc' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer TokenValue'

Field Mapping

The field naming convention between Classic and Jamf Pro APIs poses another challenge that must be addressed when attempting to migrate between these API endpoints. To assist you in parsing the response from the Jamf Pro API and updating your applications to consume this new data model, we've provided a table which details the mapping of field names between the Classic and Jamf Pro API endpoints. See below for more details.