---
title: "List organization pattern configurations"
method: GET
path: "/orgs/{org}/secret-scanning/pattern-configurations"
tags: ["secret-scanning"]
---

# List organization pattern configurations

`GET /orgs/{org}/secret-scanning/pattern-configurations`

Lists the secret scanning pattern configurations for an organization.

Personal access tokens (classic) need the `read:org` scope to use this endpoint.

## Path parameters

- `org` string, required

## Response `200`

Response

- SecretScanningPatternConfiguration — A collection of secret scanning patterns and their settings related to push protection.
  - `pattern_config_version` string, nullable — The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update.
  - `provider_pattern_overrides` SecretScanningPatternOverride[] — Overrides for partner patterns.
    - `token_type` string — The ID of the pattern.
    - `custom_pattern_version` string, nullable — The version of this pattern if it's a custom pattern.
    - `slug` string — The slug of the pattern.
    - `display_name` string — The user-friendly name for the pattern.
    - `alert_total` integer — The total number of alerts generated by this pattern.
    - `alert_total_percentage` integer — The percentage of all alerts that this pattern represents, rounded to the nearest integer.
    - `false_positives` integer — The number of false positive alerts generated by this pattern.
    - `false_positive_rate` integer — The percentage of alerts from this pattern that are false positives, rounded to the nearest integer.
    - `bypass_rate` integer — The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer.
    - `default_setting` 'disabled' | 'enabled' — The default push protection setting for this pattern.
    - `enterprise_setting` 'not-set' | 'disabled' | 'enabled', nullable — The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.
    - `setting` 'not-set' | 'disabled' | 'enabled' — The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.
  - `custom_pattern_overrides` SecretScanningPatternOverride[] — Overrides for custom patterns defined by the organization.
    - `token_type` string — The ID of the pattern.
    - `custom_pattern_version` string, nullable — The version of this pattern if it's a custom pattern.
    - `slug` string — The slug of the pattern.
    - `display_name` string — The user-friendly name for the pattern.
    - `alert_total` integer — The total number of alerts generated by this pattern.
    - `alert_total_percentage` integer — The percentage of all alerts that this pattern represents, rounded to the nearest integer.
    - `false_positives` integer — The number of false positive alerts generated by this pattern.
    - `false_positive_rate` integer — The percentage of alerts from this pattern that are false positives, rounded to the nearest integer.
    - `bypass_rate` integer — The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer.
    - `default_setting` 'disabled' | 'enabled' — The default push protection setting for this pattern.
    - `enterprise_setting` 'not-set' | 'disabled' | 'enabled', nullable — The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.
    - `setting` 'not-set' | 'disabled' | 'enabled' — The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.

## Other responses

- `403` — Forbidden
- `404` — Resource not found

---

[API](https://skmtc.net/github/apis/github-v3-rest-api.md) · [All operations](https://skmtc.net/github/apis/github-v3-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/github/github-v3-rest-api/versions/a367f7028301/schema)