Skip to main content
GET
/
v1
/
findings
/
{finding_id}
Describe a finding
curl --request GET \
  --url https://api.app.chainloop.dev/v1/findings/{finding_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.app.chainloop.dev/v1/findings/{finding_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.app.chainloop.dev/v1/findings/{finding_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.app.chainloop.dev/v1/findings/{finding_id}")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

Authorization
string
header
required

Bearer token for authentication

Path Parameters

finding_id
string
required

ID of the finding

Response

A successful response.

Response for the Describe method

result
FindingDetail · object

Full details of a security finding

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"
}