Sign in
latestOpenAPI 3.0.3GitGuardian2026-08-201871515.0 MB

511b067cdcb1

Secret Detectors

List secret detectors

List secret detectors.

get/v1/secret_detectors

Query parameters

cursorstring

Pagination cursor.

per_pageinteger

Number of items to list per page.

is_activeboolean

Filter only active or inactive detectors.

Example:true
type'specific' | 'generic' | 'custom'

Filter detectors on their type.

Example:generic
searchstring
Example:aws
ordering'name' | '-name'

Sort the results by their field value. The default sort is ASC, DESC if the field is preceded by a '-'.

Response

List of Secret Detectors

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
  }
]