---
title: "Get a secret detector"
method: GET
path: "/v1/secret_detectors/{detector_name}"
tags: ["Secret Detectors"]
---

# Get a secret detector

`GET /v1/secret_detectors/{detector_name}`

Get a secret detector.

## Path parameters

- `detector_name` string, required

## Response `200`

Secret Detector

- object
  - `name` string
  - `display_name` string
  - `type` 'specific' | 'generic' | 'custom'
  - `category` string
  - `is_active` boolean — Whether the detector is currently enabled on the workspace
  - `scans_code_only` boolean — Whether the detector can scan other kinds of resources than VCS ones
  - `checkable` boolean — Indicates whether this detector has a validity checker
  - `use_with_validity_check_disabled` boolean — If false, this detector will not be used if secret validity check is disabled on the workspace
  - `frequency` number — Number of secrets found per million of commits from GitGuardian experience of open-source monitoring
  - `removed_at` string, date-time, nullable — Date at which this detector was disabled by GitGuardian
  - `open_incidents_count` integer — Number of open secret incidents on the workspace associated to this detector
  - `ignored_incidents_count` integer — Number of ignored secret incidents on the workspace associated to this detector
  - `resolved_incidents_count` integer — Number of resolved secret incidents on the workspace associated to this detector

## Other responses

- `401` — Invalid API key
- `403` — Permission denied
- `404` — Secret Detector not found
- `503` — API under maintenance

---

[API](https://skmtc.net/gitguardian/apis/gitguardian-api.md) · [All operations](https://skmtc.net/gitguardian/apis/gitguardian-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gitguardian/gitguardian-api/revisions/511b067cdcb1/schema)