GraphQL Schema and Documentation

You can navigate the Jamf Protect schema using the following methods:

  • Altair's documentation GUI

  • GraphQL introspection queries

Documentation in Altair

Altair GraphQL Client will display Jamf Protect API documentation populated by a Jamf Protect GraphQL API schema. The API is organized by types and fields, which can be used to create queries that read or write data to Jamf Protect.

To access the schema documentation in Altair, click Docs in the upper-right of the window.

Note:

You must set up a Jamf Protect API environment in Altair before you can access the documentation.

Introspection

You can use introspection to query the API schema directly and learn about supported queries.

The following examples show how you can use introspection to learn about the Jamf Protect API

Introspection

Description

{
 __schema {
 queryType {
   fields{
     name
     description
 }
 }
 mutationType {
   fields {
     name
     description
   }
  }
 }
}

Get all supported query and mutation field names and descriptions

{
 __schema {
   types {
     name
  }
 }
}

Return all object types in the GraphQL schema

{
 __type(name: "Computer") {
 name
 kind
 fields{
 name
 description
  }
 }
}

Return all the supported fields in the Computer type with their name and description

For more information about introspection, see Introspection on the GraphQL Foundation website.