-
Notifications
You must be signed in to change notification settings - Fork 26
The Jamf Protect API
The Jamf Protect API is the primary resource for programmatically interacting with Jamf Protect. The Jamf Protect API uses GraphQL, an advanced query service and language that allows you to search and access your data from a single endpoint.
To learn more about GraphQL, see the Introduction to GraphQL page on the GraphQL Foundation website.
For more information on the Jamf Protect API see here.
The Jamf Protect API (like most GraphQL APIs) uses the following query types as the entry point of the API:
- Queries — Search your Jamf Protect data and return a result in JSON format
- Mutations— Write changes to your Jamf Protect data and return optional results in JSON format
A full list of available queries and mutations for the Jamf Protect API can be found here.
You can incorporate Jamf Protect API requests into scripts using common languages that can make HTTP requests, such as Python and Bash. This repository contains various scripts that can be used to perform such actions as:
- Export all Alert data
- List and delete all computers that have not checked in within a specified timeframe
You can interact with and test the Jamf Protect API by using Altair GraphQL Client, a debugging application specifically designed for GraphQL APIs. With Altair, you can easily test and develop queries and interact with the GraphQL schema documentation.
To learn more about the Altair GraphQL Client application, see the Altair documentation website.