GIgitguardian
Secret Detectors

Get a secret detector

Get a secret detector.

get/v1/secret_detectors/{detector_name}

Request

  • Base URL
    https://api.gitguardian.com
  • URL
    https://api.gitguardian.com/v1/secret_detectors/{detector_name}
  • Auth
    HTTP bearer

Path parameters

detector_namestring required
Example:aws_iam

Name of the detector to retrieve

Response

Secret Detector

namestring
display_namestring
type'specific' | 'generic' | 'custom'
categorystring
is_activeboolean

Whether the detector is currently enabled on the workspace

scans_code_onlyboolean

Whether the detector can scan other kinds of resources than VCS ones

checkableboolean

Indicates whether this detector has a validity checker

use_with_validity_check_disabledboolean

If false, this detector will not be used if secret validity check is disabled on the workspace

frequencynumber

Number of secrets found per million of commits from GitGuardian experience of open-source monitoring

removed_atstring date-time nullable

Date at which this detector was disabled by GitGuardian

open_incidents_countinteger

Number of open secret incidents on the workspace associated to this detector

ignored_incidents_countinteger

Number of ignored secret incidents on the workspace associated to this detector

resolved_incidents_countinteger

Number of resolved secret incidents on the workspace associated to this detector

Example response

{
  "name": "aws_iam",
  "display_name": "AWS Keys",
  "type": "specific",
  "category": "Cloud Provider",
  "is_active": true,
  "checkable": true,
  "open_incidents_count": 17,
  "ignored_incidents_count": 9,
  "resolved_incidents_count": 42
}

Changes

No recorded changes to this operation across all 35 revisions of this API.