Mutation

rename_site

Renames an existing site in the site tree.

Arguments

input: RenameSiteInput!

The fields used to specify which site you want to rename and what the new name should be.

Input Fields

id(): ID!

The unique identifier of the site that you want to rename.

name(): String!

The new name for the site. This is the name that is displayed on the Burp Suite Enterprise Edition web UI.

Return Fields

site(): Site!

The renamed site.

Example

Query

mutation RenameSite($input: RenameSiteInput!) {
  rename_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
        }
        recorded_logins {
          id
        }
      }
      scan_configurations {
        id
      }
      email_recipients {
        id
        email
      }
      ephemeral
      agent_pool {
        id
        name
      }
      slack_channels {
        id
        name
      }
    }
  }
}

Variables

{
  "input": {
    "id": "42",
    "name": "Example Site"
  }
}