Enterprise Edition
API overview
-
Last updated: July 16, 2024
-
Read time: 1 Minute
Burp Suite Enterprise Edition provides two APIs that you can use to interact with the system from other third-party software. The GraphQL API offers the broadest range of functionality and is recommended for new integrations, while the REST API offers a simple migration for users who are familiar with the Burp Suite Professional API.
Using the APIs
In order to use either of Burp Suite Enterprise Edition's APIs, you will need to set up an API user. API users each have a unique API key that enables them to authenticate when making requests.
Note that Burp Suite Enterprise Edition's user roles apply to API users in the same way as UI users. You can only use the APIs to perform those tasks that the user permissions associated with your role allow. As such, you should make sure that any API users you set up have the correct roles applied.
More information:
-
For more information on setting up API users, see Creating API users.
-
For information on performing common tasks with GraphQL, see Performing common tasks with the GraphQL API.
-
For more information on configuring roles in Burp Suite Enterprise Edition, see Roles.