GET
/
secrets
/
{secret_id}
curl --request GET \
  --url https://example.com/api/secrets/{secret_id} \
  --header 'Authorization: Bearer <token>'
{
  "secret": "<string>",
  "description": "<string>",
  "file": "<string>",
  "line": "<string>",
  "start_line": 123,
  "end_line": 123,
  "start_column": 123,
  "end_column": 123,
  "match": "<string>",
  "rule": "<string>",
  "commit": "<string>",
  "author": "<string>",
  "email": "<string>",
  "date": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ],
  "repository_id": 123,
  "message": "<string>",
  "fingerprint": "<string>",
  "entropy": 123,
  "severity": "critical",
  "scan_type": "repo_scan",
  "whitelisted": true,
  "id": 123,
  "whitelist_id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "pr_id": 123,
  "pr_scan_id": 123,
  "commit_id": 123,
  "live_commit_id": 123,
  "live_commit_scan_id": 123,
  "repository": {
    "id": 123,
    "name": "<string>",
    "repoUrl": "<string>",
    "author": "<string>",
    "lastScanDate": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
secret_id
integer
required

Response

200
application/json
Successful Response
​
id
integer
required
​
secret
string | null
​
description
string | null
​
file
string | null
​
line
string | null
​
start_line
integer | null
​
end_line
integer | null
​
start_column
integer | null
​
end_column
integer | null
​
match
string | null
​
rule
string | null
​
commit
string | null
​
author
string | null
​
email
string | null
​
date
string | null
​
tags
string[] | null
​
repository_id
integer | null
​
message
string | null
​
fingerprint
string | null
​
entropy
number | null
​
severity
enum<string> | null
Available options:
critical,
high,
medium,
low,
informational,
unknown
​
scan_type
enum<string> | null
Available options:
repo_scan,
pr_scan,
live_commit
​
whitelisted
boolean | null
​
whitelist_id
integer | null
​
created_at
string | null
​
updated_at
string | null
​
pr_id
integer | null
​
pr_scan_id
integer | null
​
commit_id
integer | null
​
live_commit_id
integer | null
​
live_commit_scan_id
integer | null
​
repository
object | null