REST API (Beta)

Use the Panther REST API to interact with your Panther entities

Overview

The REST API is in open beta starting with Panther version 1.98, and is available to all customers. Please share any bug reports and feature requests with your Panther support team.

Panther offers a REST API to interact with certain parts of your Panther instance. Currently, you can interact with the following entities through the REST API:

Additional operations are available in the GraphQL API.

Discover the Panther REST API schema

Discover the REST API schema by downloading the OpenAPI specification file:

How to use the Panther REST API

Step 1: Identify your Panther REST API URL

To locate your REST 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.

    • If you are running a SaaS deployment of Panther, your REST URL will be the portion shown below:

    • If you are running a Cloud Connected or self-hosted deployment of Panther, the URL will be the portion shown below (inclusive of /v1):

Step 2: Generate an API token

Step 3: Invoke the Panther REST API

In addition to testing with the API Playground in the Console, you can invoke the REST API using Swagger, Postman, or this documentation:

Using Swagger to access the REST API

  1. In a web browser, navigate to the Swagger Editor.

  2. In the code editor on the left-hand side, paste in the Panther REST OpenAPI specification file found above, in Discover the Panther REST API schema.

  3. In the Available authorizations modal:

    1. Under Value, enter your API token value.

    2. Click Authorize.

  4. You can now try invoking the API:

    1. Choose an endpoint, and expand it by clicking the arrow pointing down.

    2. Click Execute.

Last updated

Was this helpful?