Panther API

Interact with Panther entities using the REST and GraphQL APIs

Overview

Panther offers a REST API and a GraphQL-over-HTTP API. You can use the API Playground in the Panther Console to explore both APIs. Before making API calls, you will need to generate an API token.

Discover the REST API schema here, and the GraphQL schema here.

Supported operations

The Panther APIs support an ever-growing set of operations that allow you to build your security workflows:

REST API Alerts Alert Comments API Tokens Data Models Globals Log Sources Queries Roles Rules Scheduled Rules Simple Rules Policies Users	GraphQL API Alerts & Errors Cloud Account Management Data Lake Queries Log Source Management Metrics Token Rotation User & Role Management

How to create a Panther API token

After you have successfully created an API token, remember to periodically rotate it. See instructions for token rotation in Rotating API tokens, below.

1. In the upper right corner of your Panther Console, click the gear icon. In the dropdown menu, click API Tokens.

2. Click Create an API Token.

   • If a token already exists, click Create New Token.

3. Provide a Name, then choose the permissions you'd like to grant this token.

   • You can find required permissions for each REST API operation on each entity's page.

   • See the required permissions per Panther Analysis Tool (PAT) command here.

4. In the IP Restrictions section, in the CIDR Blocks field, enter one or more IP addresses to which you'd like to restrict usage of the token, if any.

   • Enter the IP address(es) in CIDR notation, e.g., 10.0.0.0/8 or 8.8.8.8/32.

   • If no IP addresses are specified, the token will be usable by any IP address.

5. Click Create API Token.

   • You will see a success screen that displays the value of the API token. Copy the API token and store it in a secure location, as it will not be displayed again.

   • Optionally validate that new API token works.

Validating your API token

There may be a propagation delay of 30 to 60 seconds after adding an API token.

After generating an API token, you can validate that it's working in either the API Playground or using PAT:

API Playground

To test your API token in the API Playground in the Panther Console:

1. On the API token creation success screen, click Give it a go on our Playground.

2. At the bottom-left corner of the Playground screen, locate the REQUEST HEADERS tab. Under this tab, change the default value of the X-API-Key header from <ENTER_YOUR_KEY_HERE> to the value of your API token.

3. In the upper left corner, press the "play" icon to run the test.

PAT

You must have PAT installed to perform this test.

To test your API token using PAT in the CLI:

• Run pipenv run pat check-connection --api-token <your-api-token> --api-host <your-api-host>.

Rotating API tokens

API tokens are used to authenticate against and authorize access to Panther’s public API. As with username and password credentials, you should store API tokens securely to protect them from bad actors. Rotating your tokens periodically may lessen the likelihood of them being compromised. The Center for Internet Security (CIS) and National Institute of Standards and Technology (NIST) recommend rotating API tokens every 90 days.

You can rotate an API token in your Panther Console or by calling Panther's API itself. Once you've rotated your token, the previous one is no longer valid.

Panther Console

Rotate an API token in the Panther Console

To rotate your API token in the Panther Console:

1. In the upper right corner of your Panther Console, click the gear icon, then API Tokens.

2. Locate the token you'd like to rotate. In the upper right corner of its tile, click the three dots icon, then Rotate.

   
3. On the confirmation modal that pops up, click Continue.
4. The modal will display your new API token. You will only see this once, so be sure to copy and store it in a secure location.

REST API

Rotate an API token using the Panther REST API

You can rotate your API tokens using the Panther REST API. An API token rotates itself using the POST api-tokens/self/rotate endpoint. Learn more on API Tokens.

GraphQL API

Rotate an API token using the Panther GraphQL API

You can rotate your API tokens using the Panther GraphQL API, with the rotateAPIToken operation. Learn more about how to use this endpoint on Token Rotation.

Troubleshooting the Panther APIs

Visit the Panther Knowledge Base to view articles about the Panther APIs that answer frequently asked questions and help you resolve common errors and issues.