Suppress or unsuppress a finding (orthogonal to triage state)
curl --request POST \
--url https://{tenant}.earnie.dev/v1/findings/{findingId}/actions/suppress \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"suppress": true
}
'import requests
url = "https://{tenant}.earnie.dev/v1/findings/{findingId}/actions/suppress"
payload = { "suppress": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({suppress: true})
};
fetch('https://{tenant}.earnie.dev/v1/findings/{findingId}/actions/suppress', 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://{tenant}.earnie.dev/v1/findings/{findingId}/actions/suppress",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'suppress' => true
]),
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://{tenant}.earnie.dev/v1/findings/{findingId}/actions/suppress"
payload := strings.NewReader("{\n \"suppress\": true\n}")
req, _ := http.NewRequest("POST", 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.post("https://{tenant}.earnie.dev/v1/findings/{findingId}/actions/suppress")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"suppress\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.earnie.dev/v1/findings/{findingId}/actions/suppress")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"suppress\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain_slug": "<string>",
"title": "<string>",
"evidence": {
"kind": "oss-diff",
"local_file": "<string>",
"local_line_start": 123,
"local_line_end": 123,
"oss_file": "<string>",
"oss_line_start": 123,
"oss_line_end": 123,
"purl": "<string>",
"match_percent": 123,
"algorithm": "<string>",
"oss_file_path": "<string>",
"spans": [
{
"local_line_start": 123,
"local_line_end": 123,
"oss_line_start": 123,
"oss_line_end": 123
}
],
"match_type": "file"
},
"produced_by": {
"kind": "user",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"state": "open",
"domain": "oss",
"severity": "critical",
"suppressed": true,
"version": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"purpose": "confidentiality",
"export_signals": [
{
"regime": "<string>",
"regime_version": "<string>",
"vintage": "current",
"test": "<string>",
"state": "met",
"provenance_ref": "<string>"
}
],
"location": {
"purl": "<string>",
"path": "<string>",
"line": 123,
"end_line": 123
},
"producer_kind": "repo",
"producer_ref": "<string>",
"previous_severity": "critical",
"previous_severity_scan_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"severity_change_reason": "rescan_lowered",
"enrichments": {
"component": {
"release_date": "2023-11-07T05:31:56Z",
"latest_release_date": "2023-11-07T05:31:56Z",
"age_days": 1,
"versions_behind": 1,
"status": "<string>"
},
"license": {
"spdx_id": "<string>",
"name": "<string>",
"url": "<string>",
"copyleft": true,
"category": "permissive",
"dual_licensed": true,
"source": "<string>"
},
"vulnerabilities": [
{
"kev": true,
"known_ransomware": true,
"fixed_versions": [
"<string>"
],
"cwe": [
"<string>"
],
"cve_id": "<string>",
"cvss_score": 123,
"cvss_vector": "<string>",
"epss_score": 123,
"epss_percentile": 123,
"severity": "critical",
"source": "<string>",
"published": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z"
}
],
"geoprovenance": {
"countries": [
"<string>"
],
"locations": [
{
"country": "<string>",
"percentage": 123
}
]
},
"model": {
"derivation": {
"parents": [
"<string>"
],
"is_adapter": true,
"transform_kind": "<string>",
"adapter_type": "<string>",
"evidence_source": "<string>",
"source": "<string>"
},
"datasets": [
"<string>"
],
"bias": [
"<string>"
],
"curation": {
"audit_status": "<string>",
"declared_license": "<string>",
"source": "<string>"
},
"model_card": {
"structured": {
"ethical_considerations": [
"<string>"
],
"authors": [
"<string>"
],
"intended_use": "<string>",
"technical_limitations": "<string>",
"paper_url": "<string>"
},
"source": "<string>"
},
"shards": [
{
"filename": "<string>",
"sha256": "<string>",
"size_bytes": 123
}
],
"name": "<string>",
"author": "<string>",
"architecture": "<string>",
"model_type": "<string>",
"parameter_count": 123,
"quantization": "<string>",
"license": "<string>",
"organization": "<string>",
"source": "<string>",
"considerations": {
"ethical_considerations": [
"<string>"
],
"fairness_assessments": [
"<string>"
],
"environmental_considerations": [
"<string>"
],
"source": "<string>"
},
"modality": "<string>",
"info_code": "<string>",
"info_message": "<string>"
},
"remediation": {
"purl": "<string>",
"version": "<string>",
"coverage": "assessed",
"signals": [
{
"dimension": "vulnerability",
"kind": "<string>",
"effect": "blocking",
"fact": "<string>",
"evidence": [
{
"label": "<string>",
"url": "<string>"
}
]
}
],
"confidence": 0.5,
"confidence_reasons": [
"<string>"
],
"assessed_at": "2023-11-07T05:31:56Z",
"source": {
"provider": "<string>",
"version": "<string>"
},
"priority": "fix_now",
"action": {
"kind": "upgrade",
"upgrade_pain": "none",
"summary": "<string>",
"target_version": "<string>",
"replacement_purl": "<string>"
}
}
},
"resolution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scan_only": true,
"pending_resolution": {
"reason_slug": "<string>",
"reason_display_name": "<string>",
"justification": "<string>",
"status": "pending_review",
"suppresses": true,
"decided_by": {
"kind": "user",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"decided_at": "2023-11-07T05:31:56Z",
"decided_by_display": "<string>"
}
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}findings
Suppress or unsuppress a finding (orthogonal to triage state)
POST
/
v1
/
findings
/
{findingId}
/
actions
/
suppress
Suppress or unsuppress a finding (orthogonal to triage state)
curl --request POST \
--url https://{tenant}.earnie.dev/v1/findings/{findingId}/actions/suppress \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"suppress": true
}
'import requests
url = "https://{tenant}.earnie.dev/v1/findings/{findingId}/actions/suppress"
payload = { "suppress": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({suppress: true})
};
fetch('https://{tenant}.earnie.dev/v1/findings/{findingId}/actions/suppress', 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://{tenant}.earnie.dev/v1/findings/{findingId}/actions/suppress",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'suppress' => true
]),
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://{tenant}.earnie.dev/v1/findings/{findingId}/actions/suppress"
payload := strings.NewReader("{\n \"suppress\": true\n}")
req, _ := http.NewRequest("POST", 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.post("https://{tenant}.earnie.dev/v1/findings/{findingId}/actions/suppress")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"suppress\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.earnie.dev/v1/findings/{findingId}/actions/suppress")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"suppress\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain_slug": "<string>",
"title": "<string>",
"evidence": {
"kind": "oss-diff",
"local_file": "<string>",
"local_line_start": 123,
"local_line_end": 123,
"oss_file": "<string>",
"oss_line_start": 123,
"oss_line_end": 123,
"purl": "<string>",
"match_percent": 123,
"algorithm": "<string>",
"oss_file_path": "<string>",
"spans": [
{
"local_line_start": 123,
"local_line_end": 123,
"oss_line_start": 123,
"oss_line_end": 123
}
],
"match_type": "file"
},
"produced_by": {
"kind": "user",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"state": "open",
"domain": "oss",
"severity": "critical",
"suppressed": true,
"version": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"purpose": "confidentiality",
"export_signals": [
{
"regime": "<string>",
"regime_version": "<string>",
"vintage": "current",
"test": "<string>",
"state": "met",
"provenance_ref": "<string>"
}
],
"location": {
"purl": "<string>",
"path": "<string>",
"line": 123,
"end_line": 123
},
"producer_kind": "repo",
"producer_ref": "<string>",
"previous_severity": "critical",
"previous_severity_scan_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"severity_change_reason": "rescan_lowered",
"enrichments": {
"component": {
"release_date": "2023-11-07T05:31:56Z",
"latest_release_date": "2023-11-07T05:31:56Z",
"age_days": 1,
"versions_behind": 1,
"status": "<string>"
},
"license": {
"spdx_id": "<string>",
"name": "<string>",
"url": "<string>",
"copyleft": true,
"category": "permissive",
"dual_licensed": true,
"source": "<string>"
},
"vulnerabilities": [
{
"kev": true,
"known_ransomware": true,
"fixed_versions": [
"<string>"
],
"cwe": [
"<string>"
],
"cve_id": "<string>",
"cvss_score": 123,
"cvss_vector": "<string>",
"epss_score": 123,
"epss_percentile": 123,
"severity": "critical",
"source": "<string>",
"published": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z"
}
],
"geoprovenance": {
"countries": [
"<string>"
],
"locations": [
{
"country": "<string>",
"percentage": 123
}
]
},
"model": {
"derivation": {
"parents": [
"<string>"
],
"is_adapter": true,
"transform_kind": "<string>",
"adapter_type": "<string>",
"evidence_source": "<string>",
"source": "<string>"
},
"datasets": [
"<string>"
],
"bias": [
"<string>"
],
"curation": {
"audit_status": "<string>",
"declared_license": "<string>",
"source": "<string>"
},
"model_card": {
"structured": {
"ethical_considerations": [
"<string>"
],
"authors": [
"<string>"
],
"intended_use": "<string>",
"technical_limitations": "<string>",
"paper_url": "<string>"
},
"source": "<string>"
},
"shards": [
{
"filename": "<string>",
"sha256": "<string>",
"size_bytes": 123
}
],
"name": "<string>",
"author": "<string>",
"architecture": "<string>",
"model_type": "<string>",
"parameter_count": 123,
"quantization": "<string>",
"license": "<string>",
"organization": "<string>",
"source": "<string>",
"considerations": {
"ethical_considerations": [
"<string>"
],
"fairness_assessments": [
"<string>"
],
"environmental_considerations": [
"<string>"
],
"source": "<string>"
},
"modality": "<string>",
"info_code": "<string>",
"info_message": "<string>"
},
"remediation": {
"purl": "<string>",
"version": "<string>",
"coverage": "assessed",
"signals": [
{
"dimension": "vulnerability",
"kind": "<string>",
"effect": "blocking",
"fact": "<string>",
"evidence": [
{
"label": "<string>",
"url": "<string>"
}
]
}
],
"confidence": 0.5,
"confidence_reasons": [
"<string>"
],
"assessed_at": "2023-11-07T05:31:56Z",
"source": {
"provider": "<string>",
"version": "<string>"
},
"priority": "fix_now",
"action": {
"kind": "upgrade",
"upgrade_pain": "none",
"summary": "<string>",
"target_version": "<string>",
"replacement_purl": "<string>"
}
}
},
"resolution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scan_only": true,
"pending_resolution": {
"reason_slug": "<string>",
"reason_display_name": "<string>",
"justification": "<string>",
"status": "pending_review",
"suppresses": true,
"decided_by": {
"kind": "user",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"decided_at": "2023-11-07T05:31:56Z",
"decided_by_display": "<string>"
}
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}{
"code": "<string>",
"message": "<string>"
}Authorizations
An Earnie API key, sent as Authorization: Bearer sk_earnie_.... Create one under Settings > API keys. The key's scopes decide which operations it may call.
Path Parameters
Body
application/json
Response
Updated finding after suppression toggle
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
open, assigned, resolved, superseded_by_rule, reopened Available options:
oss, crypto, ai, deps, provenance Available options:
critical, high, medium, low, info, none Per-finding crypto purpose. Present for crypto findings and null for other finding domains.
Available options:
confidentiality, excluded, support, unknown Per-finding Export Signals for the current regime, current-vintage rows first. Rows computed under a superseded regime version are still returned, marked vintage: retired; they are never dropped, because a regime bump would otherwise empty this array for every project that has not re-scanned. Other finding domains return an empty array.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Which producer last observed this finding.
Available options:
repo, upload, pr_ci, agent Human-readable provenance reference (e.g. Null when not set.
The severity this finding carried before the most recent re-scan changed it. severity is recomputed and overwritten on every re-scan, so without this the previous value is simply gone. Null means no re-scan has ever moved this finding's severity — it is not "unknown", and it must not be read as "was previously none".
Available options:
critical, high, medium, low, info, none The scan run this finding was last observed at while it still carried previous_severity, so a client can state the whole fact — "was critical at scan " — instead of an unattributable claim. Null when no transition has been recorded, and also when the earlier observation predates scan-run tracking: a set previous_severity with a null scan run is a real transition whose scan cannot be named.
Which direction the recorded transition went, and the only field that distinguishes a downgrade from a raise. Null when no transition has been recorded.
Available options:
rescan_lowered, rescan_raised Canonical PURL-keyed enrichments attached at read time.
Show child attributes
Show child attributes
ID of the resolution that currently explains this finding's resolved state. Null when the finding is open, reopened, or superseded by a rule. Set on resolve; cleared to null on reopen, supersede, or revert. Consumers can use this to fetch the full resolution record in one query rather than replaying audit events.
True when the finding was read from a pull request scan's own result set and no standing project finding carries its id: the pull request introduced it and it has not reached the default branch. It can still be resolved, reopened and approved: the decision is kept by identity and applies when the finding reaches the default branch. Assign, suppress and create-rule answer 409 finding_scan_only until it does. Absent or false everywhere else.
A resolve decision taken on a finding a pull request introduced (scan_only). It is kept by the finding's identity and becomes the resolution it describes when that identity first reaches the default branch. Until then the pull request reads the finding as resolved, and out of its gate when suppresses is true. Present only on a scan_only finding that carries one.
Show child attributes
Show child attributes