project_security_scanners
Gets or lists a project_security_scanners resource.
Overview​
| Name | project_security_scanners |
| Type | Resource |
| Id | gitlab.security.project_security_scanners |
Fields​
The following fields are returned by SELECT queries:
- get
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
available | array | |
enabled | array | |
pipeline_run | array |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | full_path, host | Information about security analyzers used in the project. Generated from the GitLab GraphQL schema field Project.securityScanners (SecurityScanners). |
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​
- get
Information about security analyzers used in the project. Generated from the GitLab GraphQL schema field Project.securityScanners (SecurityScanners).
SELECT
available,
enabled,
pipeline_run
FROM gitlab.security.project_security_scanners
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;