Get security finding details

GET

/security/findings/{id}

const url = 'https://shoehorn.example.com/api/v1/security/findings/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://shoehorn.example.com/api/v1/security/findings/example

Parameters

Path Parameters

required

string

Responses

200

Finding details with remediation guidance

application/json

object

string format: uuid

entity_id

string

entity_name

string

type

E.g., missing_owner, no_readme, exposed_secret

string

severity

string

Allowed values: critical high medium low info

status

string

Allowed values: open acknowledged resolved false_positive

title

string

description

string

remediation

Suggested fix

string

source

E.g., scorecard, scanner, manual

string

created_at

string format: date-time

resolved_at

string format: date-time

Example

{
  "severity": "critical",
  "status": "open"
}