Mutation
create_site
Creates a new site in the site tree of Burp Suite Enterprise Edition.
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_v2():
ScopeV2Input
The site scope.
api_definitions():
[ApiDefinitionInput!]
The API definition.
scan_configuration_ids():
[ID!]
A list of IDs for scan configurations that you want to use for scans of this site.
extension_ids():
[ID!]
A list of IDs for extensions that you want to use for scans of this site.
bcheck_ids():
[ID!]
A list of IDs for BChecks that you want to use for scans of this site.
application_logins():
ApplicationLoginInput
All the application logins that you want to use for scans of this site. These can either be basic sets of login credentials or scripts of full login sequences that you recorded with the Burp Suite Navigation Recorder browser extension. These are used by scans to crawl areas of the site that are only accessible to registered users. Note that you can only use one type of application login for each site.
email_recipients():
[EmailRecipientInput!]
A list of all the email addresses that should receive scan reports whenever scans of this site finish.
agent_pool_id():
ID
The agent pool the site will be in. Assigns the site to the default pool if not specified.
slack_channels():
SlackChannelsInput
The information about Slack notifications for this site.
settings():
CreateSiteSettingsInput
Settings that are applied to the new site.
Return Fields
site():
Site!
The newly created site.
Example
Query
mutation CreateSite($input: CreateSiteInput!) {
create_site(input: $input) {
site {
id
name
parent_id
scope_v2 {
start_urls
in_scope_url_prefixes
out_of_scope_url_prefixes
protocol_options
}
application_logins {
login_credentials {
id
label
username
}
recorded_logins {
id
label
}
}
scan_configurations {
id
}
extensions {
id
}
email_recipients {
id
email
}
ephemeral
agent_pool {
id
name
agents {
id
name
}
}
slack_channels {
id
name
}
settings {
request_headers {
id
name
value
scope_prefix
}
request_cookies {
id
name
value
scope_prefix
}
}
}
}
}
Variables
{
"input": {
"name": "Example Site",
"parent_id": "0",
"scope_v2": {
"start_urls": ["example.com"],
"in_scope_url_prefixes": null,
"out_of_scope_url_prefixes": null,
"protocol_options": "USE_HTTP_AND_HTTPS"
},
"application_logins": {
"login_credentials": [],
"recorded_logins": []
},
"scan_configuration_ids": [],
"extension_ids": [],
"email_recipients": [],
"agent_pool_id": null,
"slack_channels": {
"recipients": []
},
"settings": {
"request_cookies": [],
"request_headers": []
}
}
}