GraphQL API
Use the Panther GraphQL API to interact with your Panther entities
Last updated
Was this helpful?
Use the Panther GraphQL API to interact with your Panther entities
Last updated
Was this helpful?
Panther offers a public GraphQL-over-HTTP API, meaning you can write GraphQL queries and invoke the API using a typical HTTP request. For more information on GraphQL, see .
Currently, you can interact with the following entities through the GraphQL API:
Additional operations are available in the .
There are three ways to discover the GraphQL schema:
Option 1 (quickest): Download the publicly available GraphQL schema file
To locate your GraphQL API URL:
In the upper-right corner of your Panther Console, click the gear icon, then API Tokens.
At the top of the page, see the API URL.
The GraphQL API URL structure differs depending on your Panther deployment model:
Option 1 (recommended): Install and use a GraphQL Client to abstract the transport-related complexities
Option 2: Manually construct an HTTP call
While all GraphQL operations are essentially simple HTTP calls, the advantage of using a GraphQL client is that it is more user-friendly.
We recommend using:
Below are some examples of how you would construct a GraphQL query to fetch the first page of alerts in your system:
Option 2 (most user-friendly): Use
Option 3 (best for tools and services): Perform an against the GraphQL endpoint
You can download the latest version of the GraphQL schema file .
Panther's API Playground is a user-friendly way of browsing and discovering what's supported in our API. Please refer to our for information on how to use this as a discoverability mechanism.
For security purposes, the introspection query is an authorized operation. This means that you'll need to add an X-API-Key
header to your HTTP call with the value of an in order for the introspection to work.
deployments: https://api.{YOUR_PANTHER_DOMAIN}.runpanther.net/public/graphql
and deployments: https://{YOUR_PANTHER_DOMAIN}/v1/public/graphql
See .
In addition to testing with the , there are two ways to invoke a GraphQL-over-HTTP API:
for your NodeJS projects
for your Python projects
for your Go projects