Create a secret-finding

POST

/secret-findings

• Current canonical versioned path (F3.API.01)

Authorizations

• bearerAuth
• apiTokenAuth

Request Body ^required

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:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

acknowledged_at

string format: date-time

notes

string

organisation

One of:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

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

Responses

200

Created

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:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

acknowledged_at

string format: date-time

notes

string

organisation

One of:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

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

400

Validation error

401

Missing or invalid authentication

403

Not authorized (tenant scope or capability)