Mutations

Updates an existing scan configuration and returns the new configuration.

Creates a new scan configuration.

Permanently removes an existing scan configuration from Burp Suite Enterprise Edition.

Creates a new schedule item, which exposes all of the scheduling data about a configured scan. When a scheduled scan is due to start, a Scan object is created based on the associated schedule item.

Updates an existing schedule item. For example, you can change the date and time when a scan is due to start or how often a recurring scan should run.

Permanently removes a scan from Burp Suite Enterprise Edition. Note that you cannot delete a scan that is currently running. To delete a running scan, you need to cancel it first. Deleting a scan also removes all of the data that it generated, such as any issues that it found.

Permanently removes a schedule item from Burp Suite Enterprise Edition.

Cancels a scan that is currently scheduled or running in Burp Suite Enterprise Edition.

Updates whether a given issue is marked as a false positive or not.

Mark an issue as a false positive.

Allows some issue fields to be modified. Currently severity and accepted risk are supported.

Updates the maximum number of concurrent scans that are allowed to run on a given agent machine.

Updates the name for an existing agent machine.

Enables or disables an existing agent machine. An agent machine but be enabled in order to run scans. While disabled, it will be skipped when new scans are distributed among your pool of agent machines.

Confirms the authorization of a new agent machine for which an authorization request is currently pending. All new agent machines must be authorized before they can communicate with the Enterprise server and run scans.

Revokes the authorization of an existing agent machine so that it can no longer communicate with the Enterprise server or run scans.

Permanently removes a site from the site tree in Burp Suite Enterprise Edition. Note that when you delete a site, all of the associated data is also deleted. This includes any scans that were performed on the site and their results.

Permanently removes a folder from the site tree in Burp Suite Enterprise Edition. Note that deleting a folder also deletes any subfolders and sites that it contains, along with their associated data.

Creates a new folder in the site tree of Burp Suite Enterprise Edition.

Creates a new site in the site tree of Burp Suite Enterprise Edition.

Renames an existing site in the site tree.

Renames an existing folder in the site tree.

Updates the scan configurations for a given site.

Updates the extensions assigned to a site.

Updates the BChecks assigned to a site.

Updates the site scope.

Updates the API definition.

Updates the enabled endpoints for an API Definition.

Updates the Authentication for an API Definition.

Adds a new set of login credentials for a given site. This set of credentials is used by scans to crawl areas of the site that are only accessible to registered users. Note that this does not create a new user account on the actual website. The credentials that you specify here must already be valid for the website that you want to scan.

Updates an existing set of login credentials for a site. For example, if the user's password has changed, you can update the corresponding entry in Burp Suite Enterprise Edition to reflect this change.

Permanently removes a saved set of login credentials for a site.

Adds a new recorded login sequence for a given site. Note that you need to record the login sequence first using the Burp Suite Navigation Recorder browser extension in order to generate a JSON-based script. The script is used by scans to replicate the manual actions you performed in the browser. This enables Burp Scanner to handle more complex login mechanisms, such as single sign-on, in order to crawl areas of the site that are only accessible to registered users.

Permanently removes a recorded login sequence for a site.

Adds a new recipient to the list of people who receive scan completion reports for a given site.

Updates the email address of an existing recipient of scan completion reports.

Permanently removes an existing recipient of scan completion reports.

Updates information about Slack notifications for a specific site.

Delete a request header from a site.

Delete a request cookie from a site.

Add a new request header to a site.

Add a new request cookie to a site.

Updating an existing request header for a site.

Updating an existing request cookie for a site.

Add a new platform authentication to a site

Add a new platform authentication to a folder

Delete a platform authentication from a site

Delete a platform authentication from a folder

Add a new proxy configuration for a site

Delete a proxy configuration from a site

Add a new proxy configuration for a Folder

Delete a proxy configuration from a Folder

Moves a site to a different location in the site tree.

Moves a folder, and its contents, to a different location in the site tree.

Updates the scan configurations for a given folder.

Updates the extensions assigned to a folder.

Updates the BChecks assigned to a folder.

Adds a new recipient to the list of people who receive scan completion reports for a given folder.

Updates the email address of an existing recipient of scan completion reports for a folder.

permanently removes an existing recipient of scan completion reports for a folder.

Creates a new agent pool.

Updates the name and description for an existing agent pool.

Permanently deletes an agent pool. Any agents in the pool will be returned to the default pool, and any sites configured to scan using the agent pool will instead use the default pool.

Moves an agent from its current pool to a new pool.

Assign sites to an agent pool, so only agents in that pool will scan those sites.

Get information about a BApp without adding it to the list of usable extensions.

Uploads a new burp extension from a bapp file as a base64-encoded string. If there's already a different version of this extension, then it will be replaced.

Uploads a new custom extension from a .jar file as a base64-encoded string.

Remove a custom extension or a BApp from the library and any sites it is assigned to.

Updates the name property of a custom extension.

Updates the description property of a custom extension.

Updates the .jar file for a custom extension.

Add a new request header to a folder

Add a new request cookie to a folder

Updating an existing request header for a folder

Delete a request header from a folder

Delete a request cookie from a folder

Updating an existing request cookie for a folder

Run a pre-scan check to confirm that the site is reachable.

Cancels a pre-scan check.

Uploads a new bcheck.

Updates a new bcheck.

Upload a BCheck to replace an existing BCheck with the same name

Remove a BCheck from the library and any sites it is assigned to.