project_dast_scanner_profiles

Gets or lists a project_dast_scanner_profiles resource.

Overview

Name	project_dast_scanner_profiles
Type	Resource
Id	gitlab.security.project_dast_scanner_profiles

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	ID of the DAST scanner profile.
profile_name	string	Name of the DAST scanner profile.
edit_path	string	Relative web path to the edit page of a scanner profile.
referenced_in_security_policies	array
scan_type	string	Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan. (PASSIVE, ACTIVE)
show_debug_messages	boolean	Indicates if debug messages should be included in DAST console output. True to include the debug messages.
spider_timeout	integer	Maximum number of minutes allowed for the spider to traverse the site.
target_timeout	integer	Maximum number of seconds allowed for the site under test to respond to a request.
use_ajax_spider	boolean	Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host		DAST scanner profiles associated with the project. Generated from the GitLab GraphQL schema field Project.dastScannerProfiles (connection of DastScannerProfile nodes).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
full_path	string	Full path of the project, for example gitlab-org/gitlab
host	string	GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST)

SELECT examples

list

DAST scanner profiles associated with the project. Generated from the GitLab GraphQL schema field Project.dastScannerProfiles (connection of DastScannerProfile nodes).

SELECT
id,
profile_name,
edit_path,
referenced_in_security_policies,
scan_type,
show_debug_messages,
spider_timeout,
target_timeout,
use_ajax_spider
FROM gitlab.security.project_dast_scanner_profiles
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;