Skip to content

Get a single secret-finding by id

GET
/secret-findings/{id}
id
required
string

DocumentId

OK

object
data
object
repo_name
required
string
repo_provider
string
Allowed values: gitea github gitlab
commit_sha
required
string
file_path
required
string
line_number
integer
rule_id
required
string
rule_description
string
severity
string
Allowed values: critical high medium low
status
string
Allowed values: open acknowledged false_positive resolved
detected_at
string format: date-time
acknowledged_by
One of:

DocumentId reference to plugin::users-permissions.user

string
acknowledged_at
string format: date-time
notes
string
organisation
One of:

DocumentId reference to api::organisation.organisation

string
secret_type
string
Allowed values: aws_access_key private_key api_key password connection_string generic_token unknown
matched_pattern

Name of the matched pattern rule — never contains the actual secret value

string
context_snippet

Anonymized context around the match — secret value replaced with [REDACTED]

string
documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
nullable

Missing or invalid authentication

Not authorized (tenant scope or capability)

Not found