Mutation

update_site_scope_v2

Updates the site scope.

Arguments

input: UpdateSiteScopeV2Input!

The fields used to specify which site you want to update, and the site scope.

Input Fields

site_id(): ID!

The unique identifier of the site whose scope you want to update.

scope_v2(): ScopeV2Input!

The site scope.

confirm_permission_to_scan(): Boolean

If you are using a hosted dashboard version of Burp Suite DAST, enable this setting to confirm that you have permission to scan all URLs within your configured scope. You do not need to do this if you are using a self-hosted version of Burp Suite DAST.

Return Fields

site(): Site

The updated site.

Example

Query

mutation UpdateSiteScopeV2($input: UpdateSiteScopeV2Input!) {
  update_site_scope_v2(input: $input) {
    site {
      id
      name
      parent_id
      ephemeral
      scope_v2 {
        start_urls
        in_scope_url_prefixes
        out_of_scope_url_prefixes
        protocol_options
      }
      scan_configurations {
        id
      }
      extensions {
        id
      }
      application_logins {
        login_credentials {
          id
          label
          username
          password
        }
        recorded_logins {
          id
          label
          script
        }
      }
      email_recipients {
        id
        email
      }
      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": {
    "site_id": "42",
    "scope_v2": {
      "start_urls": [
        "http://example.com"
      ],
      "in_scope_url_prefixes": [],
      "out_of_scope_url_prefixes": [],
      "protocol_options": "USE_HTTP_AND_HTTPS"
    }
  }
}