Update a finding
curl --request PUT \
--url https://api.app.chainloop.dev/v1/findings/{finding_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "FINDING_STATUS_UNSPECIFIED",
"status_detail": "FINDING_STATUS_DETAIL_UNSPECIFIED",
"resolution_reason": "FINDING_RESOLUTION_REASON_UNSPECIFIED"
}
'import requests
url = "https://api.app.chainloop.dev/v1/findings/{finding_id}"
payload = {
"status": "FINDING_STATUS_UNSPECIFIED",
"status_detail": "FINDING_STATUS_DETAIL_UNSPECIFIED",
"resolution_reason": "FINDING_RESOLUTION_REASON_UNSPECIFIED"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'FINDING_STATUS_UNSPECIFIED',
status_detail: 'FINDING_STATUS_DETAIL_UNSPECIFIED',
resolution_reason: 'FINDING_RESOLUTION_REASON_UNSPECIFIED'
})
};
fetch('https://api.app.chainloop.dev/v1/findings/{finding_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.app.chainloop.dev/v1/findings/{finding_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'FINDING_STATUS_UNSPECIFIED',
'status_detail' => 'FINDING_STATUS_DETAIL_UNSPECIFIED',
'resolution_reason' => 'FINDING_RESOLUTION_REASON_UNSPECIFIED'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.app.chainloop.dev/v1/findings/{finding_id}"
payload := strings.NewReader("{\n \"status\": \"FINDING_STATUS_UNSPECIFIED\",\n \"status_detail\": \"FINDING_STATUS_DETAIL_UNSPECIFIED\",\n \"resolution_reason\": \"FINDING_RESOLUTION_REASON_UNSPECIFIED\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.app.chainloop.dev/v1/findings/{finding_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"FINDING_STATUS_UNSPECIFIED\",\n \"status_detail\": \"FINDING_STATUS_DETAIL_UNSPECIFIED\",\n \"resolution_reason\": \"FINDING_RESOLUTION_REASON_UNSPECIFIED\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.app.chainloop.dev/v1/findings/{finding_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"FINDING_STATUS_UNSPECIFIED\",\n \"status_detail\": \"FINDING_STATUS_DETAIL_UNSPECIFIED\",\n \"resolution_reason\": \"FINDING_RESOLUTION_REASON_UNSPECIFIED\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"package_purl": "package_purl",
"fixed_in_id": "fixed_in_id",
"status_changed_at": "2000-01-23T04:56:07.000Z",
"recommendation": "recommendation",
"created_at": "2000-01-23T04:56:07.000Z",
"external_id": "external_id",
"source": "source",
"project_name": "project_name",
"first_seen_in_id": "first_seen_in_id",
"project_version_name": "project_version_name",
"updated_at": "2000-01-23T04:56:07.000Z",
"last_seen_in_id": "last_seen_in_id",
"assessment_ids": [
"assessment_ids",
"assessment_ids"
],
"details": "{}",
"id": "id",
"severity": "FINDING_SEVERITY_UNSPECIFIED",
"source_format": "source_format",
"component_id": "component_id",
"is_in_kev": true,
"first_seen_at": "2000-01-23T04:56:07.000Z",
"vulnerability": {
"is_in_kev": true,
"description": "description",
"external_id": "external_id",
"id": "id",
"cwes": [
"cwes",
"cwes"
],
"cvss_vectors": [
"cvss_vectors",
"cvss_vectors"
]
},
"finding_type": "FINDING_TYPE_UNSPECIFIED",
"status_detail": "FINDING_STATUS_DETAIL_UNSPECIFIED",
"resolution_reason": "FINDING_RESOLUTION_REASON_UNSPECIFIED",
"fixed_version": "fixed_version",
"resolved_at": "2000-01-23T04:56:07.000Z",
"artifact_ids": [
"artifact_ids",
"artifact_ids"
],
"location": "location",
"effective_assessment_status": "ASSESSMENT_STATUS_UNSPECIFIED",
"last_seen_at": "2000-01-23T04:56:07.000Z",
"status": "FINDING_STATUS_UNSPECIFIED"
}
}{
"code": 0,
"details": [
"details",
"details"
],
"message": "message"
}{
"code": 6,
"details": [
"details",
"details"
],
"message": "message"
}{
"code": 1,
"details": [
"details",
"details"
],
"message": "message"
}{
"code": 5,
"details": [
"details",
"details"
],
"message": "message"
}{
"code": 5,
"details": [
{
"@type": "@type"
},
{
"@type": "@type"
}
],
"message": "message"
}Update a finding
Transition a finding’s lifecycle status. resolution_reason is only accepted when the new status is resolved or rejected and is cleared otherwise.
PUT
/
v1
/
findings
/
{finding_id}
Update a finding
curl --request PUT \
--url https://api.app.chainloop.dev/v1/findings/{finding_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "FINDING_STATUS_UNSPECIFIED",
"status_detail": "FINDING_STATUS_DETAIL_UNSPECIFIED",
"resolution_reason": "FINDING_RESOLUTION_REASON_UNSPECIFIED"
}
'import requests
url = "https://api.app.chainloop.dev/v1/findings/{finding_id}"
payload = {
"status": "FINDING_STATUS_UNSPECIFIED",
"status_detail": "FINDING_STATUS_DETAIL_UNSPECIFIED",
"resolution_reason": "FINDING_RESOLUTION_REASON_UNSPECIFIED"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 'FINDING_STATUS_UNSPECIFIED',
status_detail: 'FINDING_STATUS_DETAIL_UNSPECIFIED',
resolution_reason: 'FINDING_RESOLUTION_REASON_UNSPECIFIED'
})
};
fetch('https://api.app.chainloop.dev/v1/findings/{finding_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.app.chainloop.dev/v1/findings/{finding_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'FINDING_STATUS_UNSPECIFIED',
'status_detail' => 'FINDING_STATUS_DETAIL_UNSPECIFIED',
'resolution_reason' => 'FINDING_RESOLUTION_REASON_UNSPECIFIED'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.app.chainloop.dev/v1/findings/{finding_id}"
payload := strings.NewReader("{\n \"status\": \"FINDING_STATUS_UNSPECIFIED\",\n \"status_detail\": \"FINDING_STATUS_DETAIL_UNSPECIFIED\",\n \"resolution_reason\": \"FINDING_RESOLUTION_REASON_UNSPECIFIED\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.app.chainloop.dev/v1/findings/{finding_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"FINDING_STATUS_UNSPECIFIED\",\n \"status_detail\": \"FINDING_STATUS_DETAIL_UNSPECIFIED\",\n \"resolution_reason\": \"FINDING_RESOLUTION_REASON_UNSPECIFIED\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.app.chainloop.dev/v1/findings/{finding_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"FINDING_STATUS_UNSPECIFIED\",\n \"status_detail\": \"FINDING_STATUS_DETAIL_UNSPECIFIED\",\n \"resolution_reason\": \"FINDING_RESOLUTION_REASON_UNSPECIFIED\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"package_purl": "package_purl",
"fixed_in_id": "fixed_in_id",
"status_changed_at": "2000-01-23T04:56:07.000Z",
"recommendation": "recommendation",
"created_at": "2000-01-23T04:56:07.000Z",
"external_id": "external_id",
"source": "source",
"project_name": "project_name",
"first_seen_in_id": "first_seen_in_id",
"project_version_name": "project_version_name",
"updated_at": "2000-01-23T04:56:07.000Z",
"last_seen_in_id": "last_seen_in_id",
"assessment_ids": [
"assessment_ids",
"assessment_ids"
],
"details": "{}",
"id": "id",
"severity": "FINDING_SEVERITY_UNSPECIFIED",
"source_format": "source_format",
"component_id": "component_id",
"is_in_kev": true,
"first_seen_at": "2000-01-23T04:56:07.000Z",
"vulnerability": {
"is_in_kev": true,
"description": "description",
"external_id": "external_id",
"id": "id",
"cwes": [
"cwes",
"cwes"
],
"cvss_vectors": [
"cvss_vectors",
"cvss_vectors"
]
},
"finding_type": "FINDING_TYPE_UNSPECIFIED",
"status_detail": "FINDING_STATUS_DETAIL_UNSPECIFIED",
"resolution_reason": "FINDING_RESOLUTION_REASON_UNSPECIFIED",
"fixed_version": "fixed_version",
"resolved_at": "2000-01-23T04:56:07.000Z",
"artifact_ids": [
"artifact_ids",
"artifact_ids"
],
"location": "location",
"effective_assessment_status": "ASSESSMENT_STATUS_UNSPECIFIED",
"last_seen_at": "2000-01-23T04:56:07.000Z",
"status": "FINDING_STATUS_UNSPECIFIED"
}
}{
"code": 0,
"details": [
"details",
"details"
],
"message": "message"
}{
"code": 6,
"details": [
"details",
"details"
],
"message": "message"
}{
"code": 1,
"details": [
"details",
"details"
],
"message": "message"
}{
"code": 5,
"details": [
"details",
"details"
],
"message": "message"
}{
"code": 5,
"details": [
{
"@type": "@type"
},
{
"@type": "@type"
}
],
"message": "message"
}Authorizations
Bearer token for authentication
Path Parameters
ID of the finding
Body
application/json
Request to update a finding's lifecycle status
FindingStatus represents the lifecycle status of a finding. Transitions: OPEN → IN_PROGRESS → RESOLVED, or OPEN → REJECTED. A resolved finding can be reopened (back to OPEN) if it reappears in later evidence.
- FINDING_STATUS_OPEN: OPEN: newly detected finding, not yet triaged or acted upon
- FINDING_STATUS_IN_PROGRESS: IN_PROGRESS: finding is being investigated or actively remediated
- FINDING_STATUS_RESOLVED: RESOLVED: finding has been fixed, mitigated, or otherwise closed (see resolution_reason for details)
- FINDING_STATUS_REJECTED: REJECTED: finding has been dismissed by an operator (e.g. false positive, risk accepted, out of scope)
Available options:
FINDING_STATUS_UNSPECIFIED, FINDING_STATUS_OPEN, FINDING_STATUS_IN_PROGRESS, FINDING_STATUS_RESOLVED, FINDING_STATUS_REJECTED - FINDING_STATUS_DETAIL_MIXED_ASSESSMENTS: Active assessments at the same scope level disagree on status
Available options:
FINDING_STATUS_DETAIL_UNSPECIFIED, FINDING_STATUS_DETAIL_NEW, FINDING_STATUS_DETAIL_TRIAGED, FINDING_STATUS_DETAIL_REOPENED, FINDING_STATUS_DETAIL_INVESTIGATING, FINDING_STATUS_DETAIL_REMEDIATING, FINDING_STATUS_DETAIL_AWAITING_VERIFICATION, FINDING_STATUS_DETAIL_MIXED_ASSESSMENTS Available options:
FINDING_RESOLUTION_REASON_UNSPECIFIED, FINDING_RESOLUTION_REASON_FIXED, FINDING_RESOLUTION_REASON_OBJECT_DELETED, FINDING_RESOLUTION_REASON_MITIGATED, FINDING_RESOLUTION_REASON_FALSE_POSITIVE, FINDING_RESOLUTION_REASON_NOT_AFFECTED, FINDING_RESOLUTION_REASON_RISK_ACCEPTED, FINDING_RESOLUTION_REASON_WONT_FIX, FINDING_RESOLUTION_REASON_DUPLICATE, FINDING_RESOLUTION_REASON_OUT_OF_SCOPE Response
A successful response.
Response for the Update method
Full details of a security finding
Show child attributes
Show child attributes
Example:
{
"package_purl": "package_purl",
"fixed_in_id": "fixed_in_id",
"status_changed_at": "2000-01-23T04:56:07.000Z",
"recommendation": "recommendation",
"created_at": "2000-01-23T04:56:07.000Z",
"external_id": "external_id",
"source": "source",
"project_name": "project_name",
"first_seen_in_id": "first_seen_in_id",
"project_version_name": "project_version_name",
"updated_at": "2000-01-23T04:56:07.000Z",
"last_seen_in_id": "last_seen_in_id",
"assessment_ids": ["assessment_ids", "assessment_ids"],
"details": "{}",
"id": "id",
"severity": "FINDING_SEVERITY_UNSPECIFIED",
"source_format": "source_format",
"component_id": "component_id",
"is_in_kev": true,
"first_seen_at": "2000-01-23T04:56:07.000Z",
"vulnerability": {
"is_in_kev": true,
"description": "description",
"external_id": "external_id",
"id": "id",
"cwes": ["cwes", "cwes"],
"cvss_vectors": ["cvss_vectors", "cvss_vectors"]
},
"finding_type": "FINDING_TYPE_UNSPECIFIED",
"status_detail": "FINDING_STATUS_DETAIL_UNSPECIFIED",
"resolution_reason": "FINDING_RESOLUTION_REASON_UNSPECIFIED",
"fixed_version": "fixed_version",
"resolved_at": "2000-01-23T04:56:07.000Z",
"artifact_ids": ["artifact_ids", "artifact_ids"],
"location": "location",
"effective_assessment_status": "ASSESSMENT_STATUS_UNSPECIFIED",
"last_seen_at": "2000-01-23T04:56:07.000Z",
"status": "FINDING_STATUS_UNSPECIFIED"
}
