Object

SiteTree

The site tree is the hierarchical structure containing all sites and folders that you have configured in Burp Suite Enterprise Edition. You can use folders to organize the site tree however you want. For example, you might choose to group sites based on their geographical location or based on the different teams of developers that work on them.

Fields

folders(): [Folder!]!
A list of all folders in the site tree.
sites(): [Site!]!
A list of all sites in the site tree. This includes all user-created sites and any sites that were generated using the GraphQL API. Sites generated using the REST API will only be included if the administrator configured this in the 'Site and scan data' settings on the web UI.

Example

Query
query GetSiteTree {
    site_tree {
        sites {
            id
            name
            scope {
                included_urls
                excluded_urls
            }
            application_logins {
                label
                username
            }
        }
        folders {
            id
            name
        }
    }
}
Result
{
  "data": {
    "site_tree": {
      "sites": [
        {
          "id": "3",
          "name": "Site 3",
          "scope": {
            "included_urls": [
              "http://site3"
            ],
            "excluded_urls": []
          },
          "application_logins": []
        },
        {
          "id": "4",
          "name": "Site 1",
          "scope": {
            "included_urls": [
              "http://site1"
            ],
            "excluded_urls": [
              "http://site1/exclude"
            ]
          },
          "application_logins": [
            {
              "label": "site1",
              "username": "user"
            }
          ]
        },
        {
          "id": "5",
          "name": "Site 2",
          "scope": {
            "included_urls": [
              "http://site2"
            ],
            "excluded_urls": [
              "http://site2/excluded1",
              "http://site2/excluded2"
            ]
          },
          "application_logins": []
        }
      ],
      "folders": [
        {
          "id": "0",
          "name": "ROOT"
        },
        {
          "id": "1",
          "name": "Folder 1"
        },
        {
          "id": "2",
          "name": "Folder 2"
        }
      ]
    }
  }
}