Jamf Pro API Changelog

Jamf Pro v10.10.0
Release Date: TBD

  • The following endpoints have been added:
    • GET /device-enrollment
    • GET /device-enrollment/{id}
    • PUT /device-enrollment/{id}
    • DELETE /device-enrollment/{id}
    • PUT /action/device-enrollment/{id}/upload-token
    • POST /action/device-enrollment/upload-token
    • GET /v1/jamf-pro-server-url
    • PUT /v1/jamf-pro-server-url
    • GET /v1/jamf-pro-server-url/history
    • POST /v1/jamf-pro-server-url/history
  • The POST /inventory-preload endpoint now requires the Device Type field in addition to the Serial Number field.
  • The/settings/action/device-enrollment/{id}/disown endpoint has been moved to /action/device-enrollment/{id}/disown.
  • The /action/inventory-preload/validate-csv endpoint has been moved to /inventory-preload/validate-csv.
  • Inventory preload endpoints are no longer limited to mobile devices.
  • The GET /startup-status endpoint now defines enumerations of each stepCode.

Jamf Pro v10.9.0
Release Date: 2018-12-13

  • The Jamf Pro API Swagger documentation now includes example values in several endpoints to allow for easier use.
  • The PUT /self-service/branding/configurations/{id} endpoint has been added under the /self-service tag.
  • The GET /startup-status has been added under the /startup-status tag.
  • The following endpoints have been added under the /engage tag:
    • GET /engage
    • PUT /engage
    • GET /engage/history
    • POST /engage/history/notes
  • The SsoSettings, SsoKeystore, SsoKeystoreDetails, and SsoKeystoreWithDetails models now specify which fields are required.
  • "languageName" has been renamed to "name" in the LegacyEnrollmentProcessText and EnrollmentProcessTextObject models.
  • "isSigningMdmProfileTurnedOnByKnob" has been removed from the LegacyEnrollmentProcessText and EnrollmentProcessTextObject models.
  • "ldapServerName" has been removed from the LdapGroup model.
  • The /obj part has been removed from the /settings/obj/enrollment/settings endpoints.

Jamf Pro v10.8.0
Release Date: 2018-10-23

  • The Authorization header now uses the “Authorization: Bearer <token>” format to conform to the JWT standard. The “Authorization: jamf-token <token>” format has been deprecated and will be removed in a future release.
  • Tags in the Jamf Pro API have been reorganized to allow for easier navigation.
  • The Jamf Pro API Swagger documentation now includes default values in several endpoints to allow for easier use with client code generation and integrations.
  • The /settings/obj/enrollment/filteredLanguageCodes endpoint has been moved to /settings/obj/enrollment/filtered-languages.
  • The following endpoints have been added under the /device-enrollment tag:
    • /settings/device-enrollment/public-key
    • /settings/action/device-enrollment/{id}/disown
  • The following endpoints have been added under the /self-service tag:
    • /self-service/branding/configurations
    • /self-service/branding/configurations/{id}
  • The following endpoints have been added under the /inventory-preload tag:
    • /inventory-preload/template.csv
    • /inventory-preload/records
    • /inventory-preload/records/{id}
    • /inventory-preload/records/history
    • /action/inventory-preload/validate-csv
    Note: The inventory-preload endpoints currently apply to mobile devices only.

Jamf Pro v10.7.0
Release Date: 2018-09-14

  • The following endpoints for advanced mobile device searches have been added under the /devices tag:
    • GET /devices/advancedSearches
    • POST /devices/advancedSearches
    • GET /devices/advancedSearches/choices
    • POST /devices/advancedSearches/deleteSearches
    • GET /devices/advancedSearches/{id}
    • PUT /devices/advancedSearches/{id}
    • DELETE /devices/advancedSearches/{id}
  • The GET /devices/extensionAttributes endpoint has been added for mobile device extension attributes under the /devices tag.
    Note: The only valid query parameter for this endpoint is "select=name". Failure to input "name" will result in a 404 error.
  • The following endpoints for Single Sign-On (SSO) have been added under the /settings tag:
    • GET /settings/sso
    • PUT /settings/sso
    • GET /settings/sso/cert
    • POST /settings/sso/cert
    • PUT /settings/sso/cert
    • DELETE /settings/sso/cert
    • GET /settings/sso/metadata/download
    • GET /settings/sso/cert/download
    • GET /settings/sso/history
    • POST /settings/sso/history/notes
    Warning: Server-side validation has not been implemented for the PUT /settings/sso and PUT /settings/sso/cert endpoints. This allows invalid SSO configurations to be set via requests to these endpoints.
Jamf Pro API Removals
  • The languageName key has been removed from the EnrollmentProcessTextObject and LegacyEnrollmentProcessText models.
  • The categoryName key has been removed from the Script model.

Jamf Pro v10.6.0
Release Date: 2018-07-24

  • The priority key in the Script model now only accepts the following enumerations: BEFORE, AFTER, and AT_REBOOT.
  • The following endpoints now accept the page, pagesize, and sort query parameters:
    • GET /settings/obj/buildings
    • GET /settings/obj/enrollment/languages
    • GET /settings/obj/enrollment/accessGroups
    • GET /settings/scripts
    In addition, the response model for these endpoints now includes the totalCount key and results key. The results key displays the page results.
  • The following endpoints have been removed:
    • POST /settings/searchBuildings
    • POST /settings/scripts/search

Jamf Pro v10.5.0
Release Date: 2018-06-12

  • The PUT /uapi/settings/obj/selfservice endpoint now accepts the applicationName field.
  • The applicationName field has been added to the GET /uapi/settings/obj/selfservice endpoint.
  • The following fields have been added to the POST /inventory/obj/mobileDevice/{id}/update endpoint:
    • osType
    • isManaged
    • excludedIds