ENTERPRISE

Creating API users

  • Last updated: May 17, 2022

  • Read time: 1 Minute

If you want to integrate Burp Suite Enterprise Edition with other software, such as Jira or a CI system, you need to create a dedicated API user that the other software will use to authenticate communication with Burp Suite Enterprise Edition via either the REST API or GraphQL API.

Note

API users cannot log in to the web UI.

  1. Log in as an administrator and go to Team > Add a new user.
  2. Enter a name and username that will help you easily identify the user later, for example, "Jenkins Build".
  3. Enter an email address, for example, the email address of the admin user.
  4. Select the login type API Key.
  5. When you are happy with your changes, click the save icon in the upper-right corner.
  6. When prompted, copy the API key and URL, and save them somewhere secure. You will need these later.

Note that you cannot retrieve the API key for an existing user. If you lose it, you will have to generate a new key and manually update any files where it's used.