Secrets
Get Secret Details
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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200
application/json
Successful Response
The response is of type object
.
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"
}
}