project_vulnerability_scanners
Gets or lists a project_vulnerability_scanners resource.
Overview​
| Name | project_vulnerability_scanners |
| Type | Resource |
| Id | gitlab.security.project_vulnerability_scanners |
Fields​
The following fields are returned by SELECT queries:
- list
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
id | string | ID of the scanner. |
name | string | Name of the vulnerability scanner. |
external_id | string | External ID of the vulnerability scanner. |
report_type | string | Type of the vulnerability report. (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST, SECRET_DETECTION, COVERAGE_FUZZING, API_FUZZING, CLUSTER_IMAGE_SCANNING, CONTAINER_SCANNING_FOR_REGISTRY, SARIF, GENERIC) |
report_type_humanized | string | Humanized type of the vulnerability report. |
vendor | string | Vendor of the vulnerability scanner. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | full_path, host | Vulnerability scanners reported on the project vulnerabilities. Generated from the GitLab GraphQL schema field Project.vulnerabilityScanners (connection of VulnerabilityScanner 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
Vulnerability scanners reported on the project vulnerabilities. Generated from the GitLab GraphQL schema field Project.vulnerabilityScanners (connection of VulnerabilityScanner nodes).
SELECT
id,
name,
external_id,
report_type,
report_type_humanized,
vendor
FROM gitlab.security.project_vulnerability_scanners
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;