Mutations

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

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.

Cancels a pre-scan check.

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

Creates a new agent pool.

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

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

Add a new platform authentication to a folder

Add a new proxy configuration for a Folder

Add a new request cookie to a folder

Add a new request header to a folder

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

Creates a new scan configuration.

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.

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

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

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.

Add a new platform authentication to a site

Add a new proxy configuration 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.

Add a new request cookie to a site.

Add a new request header to a site.

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

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.

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

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

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.

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

Delete a platform authentication from a folder

Delete a proxy configuration from a Folder

Delete a request cookie from a folder

Delete a request header from a folder

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 an existing scan configuration from Burp Suite Enterprise Edition.

Permanently removes a schedule item from Burp Suite Enterprise Edition.

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 an existing recipient of scan completion reports.

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

Delete a platform authentication from a site

Delete a proxy configuration from a site

Permanently removes a recorded login sequence for a site.

Delete a request cookie from a site.

Delete a request header from a site.

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.

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

Mark an issue as a false positive.

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

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

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

Updates the name for an existing agent machine.

Renames an existing folder in the site tree.

Renames an existing site in the site tree.

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

Updates the name and description for an existing agent pool.

Updates a new bcheck.

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

Updates the description property of a custom extension.

Updates the .jar file for a custom extension.

Updates the name property of a custom extension.

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

Updates the BChecks assigned to a folder.

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

Updates the extensions assigned to a folder.

Updating an existing request cookie for a folder

Updating an existing request header for a folder

Updates the scan configurations for a given folder.

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

Updates an existing scan configuration and returns the new configuration.

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.

Updates the API definition.

Updates the Authentication for an API Definition.

Updates the enabled endpoints for an API Definition.

Updates the BChecks assigned to a site.

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

Updates the extensions assigned to a site.

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.

Updating an existing request cookie for a site.

Updating an existing request header for a site.

Updates the scan configurations for a given site.

Updates the site scope.

Updates information about Slack notifications for a specific site.

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 bcheck.

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