Getting Started

Using this API Reference

Use the resources below to familiarize yourself with the layout and functionality of this API Reference. Some functionality may differ from previous versions of the Jamf Developer portal. Before reviewing the API docs, check out the Classic API Overview for general information about the API.

Endpoint Discovery

All endpoints within the Classic API are grouped based on the resource being interacted with or the action being performed to a resource. Within the left pane, you will find a list of all available endpoints collapsed into the general feature group. A very brief description of the endpoints and the HTTP operation used to interact with that endpoint can be found when selecting a feature group from the left column.

Endpoint Details

After selecting a feature group, the center column will auto-generate descriptions, endpoint paths, supported parameters and sample request bodies for use with those endpoints. For consumers who may not be familiar with Jamf Pro features and functionality, you will also find links to documentation describing the non-API related functionality of the feature.

In addition to descriptions, you'll find sample request bodies supplied for endpoints that utilize the PUT or POST operation. These should be used outside of the developer portal, using your preferred tool for interacting with APIs. Note, these are provided purely as samples and values should be modified to suit the needs of your application.

Code Samples

The right pane includes dynamically generated code samples based on parameter values supplied in the center column.

🚧

Notice

Code samples generated for endpoints in the Classic API are generated with the JSON data type, which is not supported for PUT and POST operations with this API. Therefore, the Try It functionality has been disabled on all PUT and POST operations.

Code samples for these endpoints should not be used as-is and must be adjusted to include a request body. Sample request bodies can be found in the center pane for all endpoints that generally require a request body.

You will also notice that the auto-generated response bodies are supplied in JSON, despite the API supporting both XML and JSON for the GET operation. To return XML responses, use the Try It functionality, described below.

Try It

The ability to interact with a live Jamf Pro environment is available for most GET operations. To utilize this feature, enter the following user credentials when prompted to authenticate, then click Try It to initiate the request:

Postman

In addition to the resources on this site, Jamf provides a Postman collection for interacting with the Classic API. More information about Postman and how to use the Postman collection can be found here