Mutation

create_site

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

Arguments

input: CreateSiteInput!

The fields used to create a new site in the site tree.


Input Fields

name(): String!
The name for the new site. This is the name that is displayed on the Burp Suite Enterprise Edition web UI.
parent_id(): ID!
The unique identifier of the folder to which you want to add the new site as a child. To add the site to the root level, enter 0.
scope(): ScopeInput!
The URLs that are both included and excluded from scans of this site.
scan_configuration_ids(): [ID!]
A list of IDs for scan configurations that you want to use as the default for scans of this site. On the Burp Suite Enterprise Edition web UI, these will be preselected when users create a new scan for this site. However, when creating a schedule item using the API, the default scan configuration for the site is not automatically assigned. Therefore, even if you want to use the default configuration, you need to explicitly set it when creating a new schedule item.
application_logins(): [ApplicationLoginInput!]
A list of all the login credentials you want to add to the 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.
email_recipients(): [EmailRecipientInput!]
A list of all the email addresses that should receive scan reports whenever scans of this site finish.

Return Fields

site(): Site!
The newly created site.

Example

Query
mutation CreateSite($input: CreateSiteInput!) {
  create_site(input: $input) {
    site {
      id
      name
      parent_id
      scope {
        included_urls
        excluded_urls
      }
      application_logins {
        id
        label
        username
      }
      scan_configurations {
        id
      }
      email_recipients {
        id
        email
      }
      ephemeral
    }
  }
}
Variables
{
  "input": {
    "name": "Example Site",
    "parent_id": "0",
    "scope": {
      "included_urls": [
        "http://example.com"
      ],
      "excluded_urls": []
    },
    "application_logins": [],
    "scan_configuration_ids": [],
    "email_recipients": []
  }
}