Enterprise Edition

GraphQL API overview

Last updated: July 16, 2024
Read time: 1 Minute

If you are planning on developing a new integration of Burp Suite Enterprise Edition with your own software or a third-party tool, we recommend using the GraphQL API wherever possible.

The GraphQL API exposes virtually all of the core functionality and data of Burp Suite Enterprise Edition. Among other things, you can use the API to:

Create and edit sites.
Schedule one-off and regular scans.
Create and edit custom scan configurations.
Add folders to your site tree.
Get scan results and reports.
For standard instances, manage your pool of scanning machines.
Integrate scans as part of your build pipeline.

More information:

To get started with the GraphQL API, please refer to Getting started.
For more detailed information, please refer to our GraphQL API documentation.
For worked examples of some common tasks using the GraphQL API, please refer to the Performing common tasks with the GraphQL API page.