project_dast_site_profiles

Gets or lists a project_dast_site_profiles resource.

Overview

Name	project_dast_site_profiles
Type	Resource
Id	gitlab.security.project_dast_site_profiles

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	ID of the site profile.
profile_name	string	Name of the site profile.
edit_path	string	Relative web path to the edit page of a site profile.
excluded_urls	array
normalized_target_url	string	Normalized URL of the target to be scanned.
optional_variables	array
referenced_in_security_policies	array
request_headers	string	Comma-separated list of request header names and values to be added to every request made by DAST.
scan_file_path	string	Scan File Path used as input for the scanner.
scan_method	string	Scan method used by the scanner. (WEBSITE, OPENAPI, HAR, POSTMAN_COLLECTION, GRAPHQL)
target_type	string	Type of target to be scanned. (WEBSITE, API)
target_url	string	URL of the target to be scanned.
validation_started_at	string	Site profile validation start time.
validation_status	string	Current validation status of the site profile. (NONE, PENDING_VALIDATION, INPROGRESS_VALIDATION, PASSED_VALIDATION, FAILED_VALIDATION)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host		DAST Site Profiles associated with the project. Generated from the GitLab GraphQL schema field Project.dastSiteProfiles (connection of DastSiteProfile 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 Site Profiles associated with the project. Generated from the GitLab GraphQL schema field Project.dastSiteProfiles (connection of DastSiteProfile nodes).

SELECT
id,
profile_name,
edit_path,
excluded_urls,
normalized_target_url,
optional_variables,
referenced_in_security_policies,
request_headers,
scan_file_path,
scan_method,
target_type,
target_url,
validation_started_at,
validation_status
FROM gitlab.security.project_dast_site_profiles
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;