diff options
Diffstat (limited to 'doc/api/vulnerability_findings.md')
| -rw-r--r-- | doc/api/vulnerability_findings.md | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/doc/api/vulnerability_findings.md b/doc/api/vulnerability_findings.md index bfb1306e4aa..95e4774ae96 100644 --- a/doc/api/vulnerability_findings.md +++ b/doc/api/vulnerability_findings.md @@ -1,14 +1,14 @@ --- stage: Secure group: Threat Insights -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Vulnerability Findings API **(ULTIMATE)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/19029) in GitLab Ultimate 12.5. -NOTE: **Note:** +NOTE: This API resource is renamed from Vulnerabilities to Vulnerability Findings because the Vulnerabilities are reserved for serving [Vulnerability objects](https://gitlab.com/gitlab-org/gitlab/-/issues/13561). To fix any broken integrations with the former Vulnerabilities API, change the `vulnerabilities` URL part to be @@ -18,13 +18,13 @@ Every API call to vulnerability findings must be [authenticated](README.md#authe Vulnerability findings are project-bound entities. If a user is not a member of a project and the project is private, a request on -that project will result in a `404` status code. +that project results in a `404` status code. If a user is able to access the project but does not have permission to [use the Project Security Dashboard](../user/permissions.md#project-members-permissions), -any request for vulnerability findings of this project will result in a `403` status code. +any request for vulnerability findings of this project results in a `403` status code. -CAUTION: **Caution:** +WARNING: This API is in an alpha stage and considered unstable. The response payload may be subject to change or breakage across GitLab releases. @@ -53,7 +53,7 @@ GET /projects/:id/vulnerability_findings?scanner=bandit,find_sec_bugs GET /projects/:id/vulnerability_findings?pipeline_id=42 ``` -CAUTION: **Deprecation:** +WARNING: Beginning with GitLab 12.9, the `undefined` severity and confidence level is no longer reported. | Attribute | Type | Required | Description | @@ -99,6 +99,7 @@ Example response: } ], "project_fingerprint": "fa6f5b6c5d240b834ac5e901dc69f9484cef89ec", + "uuid": "31f483bc-bfc0-586d-9b92-f1015c4535b8", "create_vulnerability_feedback_issue_path": "/tests/yarn-remediation-test/vulnerability_feedback", "create_vulnerability_feedback_merge_request_path": "/tests/yarn-remediation-test/vulnerability_feedback", "create_vulnerability_feedback_dismissal_path": "/tests/yarn-remediation-test/vulnerability_feedback", |