All endpoints within the Jamf Pro API are grouped based on the resource you're interacting with or the action being performed to a resource. Each endpoint includes a brief description of the function it performs including an icon to denote the request method.
Endpoints that include the term preview
are not recommended for use in production applications. These endpoints are likely to experience breaking changes prior to the release of v1
. If you choose to use these endpoints, make sure to review the Jamf Pro Release Notes, prior to upgrading your Jamf Pro Server to review all changes related to the API endpoints.
Before reviewing the API docs, check out the Jamf Pro API Overview for general information about the API.
Example Code
Example code in all languages excludes authorization header information and must be added to successfully interact with the API. Use basic authentication to request a Bearer token from the api-authentication endpoint. All other endpoints require the Bearer token.
Open API 3.0
The Jamf Pro API Reference documentation is built using the Open API 3.0 (OAS 3) standard. The OAS 3.0 schema file can be downloaded from your Jamf Pro environment by appending /api/schema
to the server URL (e.g. https://yourCompany.jamfcloud.com/api/schema).
Postman
Postman is an API Client application that can simplify the way you interact with APIs. You can import API endpoints into Postman using the OAS 3.0 schema mentioned above, more information can be found here. A Postman collection for obtaining and managing Bearer Tokens from Jamf Pro can be found in the Jamf Pro API Overview documentation.