Object

Folder

A folder in the site tree. Folders can contain both sites and subfolders. You can use folders to organize the site tree into any kind of hierarchical structure. You can also restrict user permissions on the folder level.

Fields

id(): ID!
The unique identifier of the folder.
name(): String!
The name of the folder. This is the name that appears on the Burp Suite Enterprise Edition web UI. Note that the name of a folder must be unique within its parent folder.
description(): String
The description of the folder.
parent_id(): ID
The unique identifier of the folder that is the parent of this folder in the site tree hierarchy. A parent ID of 0 indicates that this folder is on the root level.
scan_configurations(): [ScanConfiguration!]
A list of the scan configurations that you want to use for scan of the sites in this folder and its subfolders.
extensions(): [Extension!]
The extensions assigned to the sites and subfolders in this folder.
bchecks(): [BCheck!]
The BChecks assigned to the sites and subfolders in this folder.
email_recipients(): [EmailRecipient!]
A list of all the email addresses that are sent scan reports for the sites that are in this folder and its subfolders.
slack_channels(): [SlackChannel!]
The information about Slack notifications for this folder.
settings(): FolderSettings
Settings that have been applied to this folder.

Example

Query 
query GetFolder($folder_id: ID!) {
  folder(id: $folder_id) {
    id
    name
    parent_id
    scan_configurations {
        id
    }
    extensions {
        id
    }
    email_recipients {
        id
        email
    }
    slack_channels {
        id
        name
    }
  }
}
Variables 
{
  "folder_id": "1"
}
Result 
{
    "data": {
        "folder": {
            "id": "1",
            "name": "folder",
            "parent_id": null,
            "scan_configurations": [
                {
                    "id": null
                }
            ],
            "extensions": [
                {
                    "id": null
                }
            ],
            "email_recipients": [
                {
                    "id": null,
                    "email": null
                }
            ],
            "slack_channels": [
                {
                    "id": null,
                    "name": null
                },
            ]
        }
    }
}