REST API endpoints for secret scanning custom patterns

List enterprise custom patterns

Lists secret scanning custom patterns for an enterprise.

Personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

"List enterprise custom patterns"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"List enterprise custom patterns"에 대한 매개 변수

머리글
이름, 유형, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, 유형, 설명
`enterprise` string 필수 The slug version of the enterprise name.

쿼리 매개 변수
이름, 유형, 설명
`state` string Filter custom patterns by state. When absent, returns patterns in all states. 다음 중 하나일 수 있습니다.: `published`, `unpublished`
`push_protection` string Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status. 다음 중 하나일 수 있습니다.: `enabled`, `disabled`
`sort` string The property to sort the results by. 기본값: `created` 다음 중 하나일 수 있습니다.: `created`, `updated`, `name`
`direction` string The direction to sort the results by. 기본값: `desc` 다음 중 하나일 수 있습니다.: `asc`, `desc`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 기본값: `1`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 기본값: `30`

"List enterprise custom patterns"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`403`	Forbidden
`404`	Resource not found

"List enterprise custom patterns"에 대한 코드 샘플

GitHub에 GHE.com으로 액세스하는 경우, api.github.com를 api.SUBDOMAIN.ghe.com에 해당하는 귀하의 엔터프라이즈 전용 하위 도메인으로 교체하십시오.

요청 예제

get/enterprises/{enterprise}/secret-scanning/custom-patterns

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/secret-scanning/custom-patterns

Response

Status: 200

[
  {
    "id": 1,
    "name": "Example Custom Pattern",
    "pattern": "[a-z]+_token_[0-9]+",
    "slug": "example-custom-pattern",
    "state": "published",
    "push_protection_enabled": true,
    "start_delimiter": null,
    "end_delimiter": null,
    "must_match": null,
    "must_not_match": null,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  },
  {
    "id": 2,
    "name": "Another Custom Pattern",
    "pattern": "prefix_[a-zA-Z0-9]{32}",
    "slug": "another-custom-pattern",
    "state": "published",
    "push_protection_enabled": false,
    "start_delimiter": "\\b",
    "end_delimiter": "\\b",
    "must_match": [
      "^prefix_prod"
    ],
    "must_not_match": [
      "test"
    ],
    "created_at": "2024-01-16T14:20:00Z",
    "updated_at": "2024-01-17T09:15:00Z"
  }
]

Bulk create enterprise custom patterns

Bulk creates secret scanning custom patterns for an enterprise.

Personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

"Bulk create enterprise custom patterns"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Bulk create enterprise custom patterns"에 대한 매개 변수

머리글
이름, 유형, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, 유형, 설명
`enterprise` string 필수 The slug version of the enterprise name.

이름, 유형, 설명

patterns array of objects 필수

The list of custom patterns to create.

Properties of patterns

이름, 유형, 설명
`name` string 필수 The name of the custom pattern.
`pattern` string 필수 The regular expression of the custom pattern.
`start_delimiter` string The start delimiter regex for the custom pattern. Defaults to `\A\|[^0-9A-Za-z]` when not specified. 기본값: `\A\|[^0-9A-Za-z]`
`end_delimiter` string The end delimiter regex for the custom pattern. Defaults to `\z\|[^0-9A-Za-z]` when not specified. 기본값: `\z\|[^0-9A-Za-z]`
`must_match` array of strings List of regexes that the secret must match.
`must_not_match` array of strings List of regexes that the secret must not match.

"Bulk create enterprise custom patterns"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`201`	All patterns created successfully.
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed for one or more patterns.

"Bulk create enterprise custom patterns"에 대한 코드 샘플

GitHub에 GHE.com으로 액세스하는 경우, api.github.com를 api.SUBDOMAIN.ghe.com에 해당하는 귀하의 엔터프라이즈 전용 하위 도메인으로 교체하십시오.

요청 예제

post/enterprises/{enterprise}/secret-scanning/custom-patterns

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/secret-scanning/custom-patterns \
  -d '{"patterns":[{"name":"Example Custom Pattern","pattern":"[a-z]+_token_[0-9]+"},{"name":"Another Custom Pattern","pattern":"prefix_[a-zA-Z0-9]{32}","start_delimiter":"\\b","end_delimiter":"\\b","must_match":["^prefix_prod"],"must_not_match":["test"]}]}'

All patterns created successfully.

Status: 201

{
  "created_patterns": [
    {
      "id": 1,
      "name": "Example Custom Pattern",
      "pattern": "[a-z]+_token_[0-9]+",
      "slug": "example-custom-pattern",
      "state": "unpublished",
      "push_protection_enabled": false,
      "start_delimiter": null,
      "end_delimiter": null,
      "must_match": null,
      "must_not_match": null,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": 2,
      "name": "Another Custom Pattern",
      "pattern": "prefix_[a-zA-Z0-9]{32}",
      "slug": "another-custom-pattern",
      "state": "unpublished",
      "push_protection_enabled": false,
      "start_delimiter": "\\b",
      "end_delimiter": "\\b",
      "must_match": [
        "^prefix_prod"
      ],
      "must_not_match": [
        "test"
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Bulk delete enterprise custom patterns

Bulk deletes secret scanning custom patterns for an enterprise.

Personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

"Bulk delete enterprise custom patterns"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Bulk delete enterprise custom patterns"에 대한 매개 변수

머리글
이름, 유형, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, 유형, 설명
`enterprise` string 필수 The slug version of the enterprise name.

이름, 유형, 설명

patterns array of objects 필수

The list of custom patterns to delete.

Properties of patterns

이름, 유형, 설명
`pattern_id` integer 필수 The ID of the custom pattern to delete.
`custom_pattern_version` string or null 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.

post_delete_action string

What to do with alerts associated with the deleted patterns. delete_alerts permanently removes the alerts. resolve_alerts resolves the alerts as "pattern deleted". Defaults to delete_alerts when not specified.

기본값: delete_alerts

다음 중 하나일 수 있습니다.: delete_alerts, resolve_alerts

"Bulk delete enterprise custom patterns"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`204`	All patterns deleted successfully.
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`412`	Precondition Failed

"Bulk delete enterprise custom patterns"에 대한 코드 샘플

GitHub에 GHE.com으로 액세스하는 경우, api.github.com를 api.SUBDOMAIN.ghe.com에 해당하는 귀하의 엔터프라이즈 전용 하위 도메인으로 교체하십시오.

요청 예제

delete/enterprises/{enterprise}/secret-scanning/custom-patterns

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/secret-scanning/custom-patterns \
  -d '{"patterns":[{"pattern_id":2,"custom_pattern_version":"0ujsswThIGTUYm2K8FjOOfXtY1K"}]}'

All patterns deleted successfully.

Status: 204

Update an enterprise custom pattern

Updates a secret scanning custom pattern for an enterprise.

Personal access tokens (classic) need the admin:enterprise scope to use this endpoint.

"Update an enterprise custom pattern"에 대한 세분화된 액세스 토큰

이 엔드포인트는 GitHub 앱 사용자 액세스 토큰, GitHub 앱 설치 액세스 토큰 또는 세분화된 개인용 액세스 토큰에서 작동하지 않습니다.

"Update an enterprise custom pattern"에 대한 매개 변수

머리글
이름, 유형, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, 유형, 설명
`enterprise` string 필수 The slug version of the enterprise name.
`pattern_id` integer 필수 The ID of the custom pattern.

본문 매개 변수
이름, 유형, 설명
`pattern` string The updated regular expression of the custom pattern.
`start_delimiter` string The updated start delimiter regex for the custom pattern.
`end_delimiter` string The updated end delimiter regex for the custom pattern.
`must_match` array of strings Updated list of regexes that the secret must match.
`must_not_match` array of strings Updated list of regexes that the secret must not match.
`custom_pattern_version` string or null 필수 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.

"Update an enterprise custom pattern"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	Pattern updated successfully.
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`412`	Precondition Failed
`422`	Validation failed, or the endpoint has been spammed.

"Update an enterprise custom pattern"에 대한 코드 샘플

GitHub에 GHE.com으로 액세스하는 경우, api.github.com를 api.SUBDOMAIN.ghe.com에 해당하는 귀하의 엔터프라이즈 전용 하위 도메인으로 교체하십시오.

요청 예제

patch/enterprises/{enterprise}/secret-scanning/custom-patterns/{pattern_id}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/enterprises/ENTERPRISE/secret-scanning/custom-patterns/PATTERN_ID \
  -d '{"pattern":"updated_secret_[0-9A-Z]{16}","start_delimiter":"[^0-9A-Za-z]","end_delimiter":"[^0-9A-Za-z]","must_match":["updated_secret_[0-9]{2}*"],"must_not_match":["updated_secret_1234567890ABCDEF"],"custom_pattern_version":"0ujsswThIGTUYm2K8FjOOfXtY1K"}'

Pattern updated successfully.

Status: 200

{
  "id": 1,
  "name": "Example Custom Pattern",
  "pattern": "updated_secret_[0-9A-Z]{16}",
  "slug": "example_custom_pattern",
  "state": "published",
  "push_protection_enabled": true,
  "start_delimiter": "[^0-9A-Za-z]",
  "end_delimiter": "[^0-9A-Za-z]",
  "must_match": [
    "updated_secret_[0-9]{2}*"
  ],
  "must_not_match": [
    "updated_secret_1234567890ABCDEF"
  ],
  "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-06-01T12:00:00Z"
}

List organization custom patterns

Lists secret scanning custom patterns for an organization.

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

"List organization custom patterns"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰은 필수 권한 집합을 포함해야 합니다.:

"Administration" organization permissions (read)

"List organization custom patterns"에 대한 매개 변수

머리글
이름, 유형, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, 유형, 설명
`org` string 필수 The organization name. The name is not case sensitive.

쿼리 매개 변수
이름, 유형, 설명
`state` string Filter custom patterns by state. When absent, returns patterns in all states. 다음 중 하나일 수 있습니다.: `published`, `unpublished`
`push_protection` string Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status. 다음 중 하나일 수 있습니다.: `enabled`, `disabled`
`sort` string The property to sort the results by. 기본값: `created` 다음 중 하나일 수 있습니다.: `created`, `updated`, `name`
`direction` string The direction to sort the results by. 기본값: `desc` 다음 중 하나일 수 있습니다.: `asc`, `desc`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 기본값: `1`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 기본값: `30`

"List organization custom patterns"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`403`	Forbidden
`404`	Resource not found

"List organization custom patterns"에 대한 코드 샘플

GitHub에 GHE.com으로 액세스하는 경우, api.github.com를 api.SUBDOMAIN.ghe.com에 해당하는 귀하의 엔터프라이즈 전용 하위 도메인으로 교체하십시오.

요청 예제

get/orgs/{org}/secret-scanning/custom-patterns

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/secret-scanning/custom-patterns

Response

Status: 200

[
  {
    "id": 1,
    "name": "Example Custom Pattern",
    "pattern": "[a-z]+_token_[0-9]+",
    "slug": "example-custom-pattern",
    "state": "published",
    "push_protection_enabled": true,
    "start_delimiter": null,
    "end_delimiter": null,
    "must_match": null,
    "must_not_match": null,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  },
  {
    "id": 2,
    "name": "Another Custom Pattern",
    "pattern": "prefix_[a-zA-Z0-9]{32}",
    "slug": "another-custom-pattern",
    "state": "published",
    "push_protection_enabled": false,
    "start_delimiter": "\\b",
    "end_delimiter": "\\b",
    "must_match": [
      "^prefix_prod"
    ],
    "must_not_match": [
      "test"
    ],
    "created_at": "2024-01-16T14:20:00Z",
    "updated_at": "2024-01-17T09:15:00Z"
  }
]

Bulk create organization custom patterns

Bulk creates secret scanning custom patterns for an organization.

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

"Bulk create organization custom patterns"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰은 필수 권한 집합을 포함해야 합니다.:

"Administration" organization permissions (write)

"Bulk create organization custom patterns"에 대한 매개 변수

머리글
이름, 유형, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, 유형, 설명
`org` string 필수 The organization name. The name is not case sensitive.

이름, 유형, 설명

patterns array of objects 필수

The list of custom patterns to create.

Properties of patterns

이름, 유형, 설명
`name` string 필수 The name of the custom pattern.
`pattern` string 필수 The regular expression of the custom pattern.
`start_delimiter` string The start delimiter regex for the custom pattern. Defaults to `\A\|[^0-9A-Za-z]` when not specified. 기본값: `\A\|[^0-9A-Za-z]`
`end_delimiter` string The end delimiter regex for the custom pattern. Defaults to `\z\|[^0-9A-Za-z]` when not specified. 기본값: `\z\|[^0-9A-Za-z]`
`must_match` array of strings List of regexes that the secret must match.
`must_not_match` array of strings List of regexes that the secret must not match.

"Bulk create organization custom patterns"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`201`	All patterns created successfully.
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed for one or more patterns.

"Bulk create organization custom patterns"에 대한 코드 샘플

GitHub에 GHE.com으로 액세스하는 경우, api.github.com를 api.SUBDOMAIN.ghe.com에 해당하는 귀하의 엔터프라이즈 전용 하위 도메인으로 교체하십시오.

요청 예제

post/orgs/{org}/secret-scanning/custom-patterns

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/secret-scanning/custom-patterns \
  -d '{"patterns":[{"name":"Example Custom Pattern","pattern":"[a-z]+_token_[0-9]+"},{"name":"Another Custom Pattern","pattern":"prefix_[a-zA-Z0-9]{32}","start_delimiter":"\\b","end_delimiter":"\\b","must_match":["^prefix_prod"],"must_not_match":["test"]}]}'

All patterns created successfully.

Status: 201

{
  "created_patterns": [
    {
      "id": 1,
      "name": "Example Custom Pattern",
      "pattern": "[a-z]+_token_[0-9]+",
      "slug": "example-custom-pattern",
      "state": "unpublished",
      "push_protection_enabled": false,
      "start_delimiter": null,
      "end_delimiter": null,
      "must_match": null,
      "must_not_match": null,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": 2,
      "name": "Another Custom Pattern",
      "pattern": "prefix_[a-zA-Z0-9]{32}",
      "slug": "another-custom-pattern",
      "state": "unpublished",
      "push_protection_enabled": false,
      "start_delimiter": "\\b",
      "end_delimiter": "\\b",
      "must_match": [
        "^prefix_prod"
      ],
      "must_not_match": [
        "test"
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Bulk delete organization custom patterns

Bulk deletes secret scanning custom patterns for an organization.

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

"Bulk delete organization custom patterns"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰은 필수 권한 집합을 포함해야 합니다.:

"Administration" organization permissions (write)

"Bulk delete organization custom patterns"에 대한 매개 변수

머리글
이름, 유형, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, 유형, 설명
`org` string 필수 The organization name. The name is not case sensitive.

이름, 유형, 설명

patterns array of objects 필수

The list of custom patterns to delete.

Properties of patterns

이름, 유형, 설명
`pattern_id` integer 필수 The ID of the custom pattern to delete.
`custom_pattern_version` string or null 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.

post_delete_action string

기본값: delete_alerts

다음 중 하나일 수 있습니다.: delete_alerts, resolve_alerts

"Bulk delete organization custom patterns"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`204`	All patterns deleted successfully.
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`412`	Precondition Failed

"Bulk delete organization custom patterns"에 대한 코드 샘플

GitHub에 GHE.com으로 액세스하는 경우, api.github.com를 api.SUBDOMAIN.ghe.com에 해당하는 귀하의 엔터프라이즈 전용 하위 도메인으로 교체하십시오.

요청 예제

delete/orgs/{org}/secret-scanning/custom-patterns

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/secret-scanning/custom-patterns \
  -d '{"patterns":[{"pattern_id":2,"custom_pattern_version":"0ujsswThIGTUYm2K8FjOOfXtY1K"}]}'

All patterns deleted successfully.

Status: 204

Update an organization custom pattern

Updates a secret scanning custom pattern for an organization.

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

"Update an organization custom pattern"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰은 필수 권한 집합을 포함해야 합니다.:

"Administration" organization permissions (write)

"Update an organization custom pattern"에 대한 매개 변수

머리글
이름, 유형, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, 유형, 설명
`org` string 필수 The organization name. The name is not case sensitive.
`pattern_id` integer 필수 The ID of the custom pattern.

본문 매개 변수
이름, 유형, 설명
`pattern` string The updated regular expression of the custom pattern.
`start_delimiter` string The updated start delimiter regex for the custom pattern.
`end_delimiter` string The updated end delimiter regex for the custom pattern.
`must_match` array of strings Updated list of regexes that the secret must match.
`must_not_match` array of strings Updated list of regexes that the secret must not match.
`custom_pattern_version` string or null 필수 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.

"Update an organization custom pattern"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	Pattern updated successfully.
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`412`	Precondition Failed
`422`	Validation failed, or the endpoint has been spammed.

"Update an organization custom pattern"에 대한 코드 샘플

GitHub에 GHE.com으로 액세스하는 경우, api.github.com를 api.SUBDOMAIN.ghe.com에 해당하는 귀하의 엔터프라이즈 전용 하위 도메인으로 교체하십시오.

요청 예제

patch/orgs/{org}/secret-scanning/custom-patterns/{pattern_id}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/orgs/ORG/secret-scanning/custom-patterns/PATTERN_ID \
  -d '{"pattern":"updated_secret_[0-9A-Z]{16}","start_delimiter":"[^0-9A-Za-z]","end_delimiter":"[^0-9A-Za-z]","must_match":["updated_secret_[0-9]{2}*"],"must_not_match":["updated_secret_1234567890ABCDEF"],"custom_pattern_version":"0ujsswThIGTUYm2K8FjOOfXtY1K"}'

Pattern updated successfully.

Status: 200

{
  "id": 1,
  "name": "Example Custom Pattern",
  "pattern": "updated_secret_[0-9A-Z]{16}",
  "slug": "example_custom_pattern",
  "state": "published",
  "push_protection_enabled": true,
  "start_delimiter": "[^0-9A-Za-z]",
  "end_delimiter": "[^0-9A-Za-z]",
  "must_match": [
    "updated_secret_[0-9]{2}*"
  ],
  "must_not_match": [
    "updated_secret_1234567890ABCDEF"
  ],
  "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-06-01T12:00:00Z"
}

List repository custom patterns

Lists secret scanning custom patterns for a repository.

OAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

"List repository custom patterns"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰은 필수 권한 집합을 포함해야 합니다.:

"Secret scanning alerts" repository permissions (read)

"List repository custom patterns"에 대한 매개 변수

머리글
이름, 유형, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, 유형, 설명
`owner` string 필수 The account owner of the repository. The name is not case sensitive.
`repo` string 필수 The name of the repository without the `.git` extension. The name is not case sensitive.

쿼리 매개 변수
이름, 유형, 설명
`state` string Filter custom patterns by state. When absent, returns patterns in all states. 다음 중 하나일 수 있습니다.: `published`, `unpublished`
`push_protection` string Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status. 다음 중 하나일 수 있습니다.: `enabled`, `disabled`
`sort` string The property to sort the results by. 기본값: `created` 다음 중 하나일 수 있습니다.: `created`, `updated`, `name`
`direction` string The direction to sort the results by. 기본값: `desc` 다음 중 하나일 수 있습니다.: `asc`, `desc`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." 기본값: `1`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." 기본값: `30`

"List repository custom patterns"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	OK
`403`	Forbidden
`404`	Resource not found

"List repository custom patterns"에 대한 코드 샘플

GitHub에 GHE.com으로 액세스하는 경우, api.github.com를 api.SUBDOMAIN.ghe.com에 해당하는 귀하의 엔터프라이즈 전용 하위 도메인으로 교체하십시오.

요청 예제

get/repos/{owner}/{repo}/secret-scanning/custom-patterns

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/secret-scanning/custom-patterns

Response

Status: 200

[
  {
    "id": 1,
    "name": "Example Custom Pattern",
    "pattern": "[a-z]+_token_[0-9]+",
    "slug": "example-custom-pattern",
    "state": "published",
    "push_protection_enabled": true,
    "start_delimiter": null,
    "end_delimiter": null,
    "must_match": null,
    "must_not_match": null,
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  },
  {
    "id": 2,
    "name": "Another Custom Pattern",
    "pattern": "prefix_[a-zA-Z0-9]{32}",
    "slug": "another-custom-pattern",
    "state": "published",
    "push_protection_enabled": false,
    "start_delimiter": "\\b",
    "end_delimiter": "\\b",
    "must_match": [
      "^prefix_prod"
    ],
    "must_not_match": [
      "test"
    ],
    "created_at": "2024-01-16T14:20:00Z",
    "updated_at": "2024-01-17T09:15:00Z"
  }
]

Bulk create repository custom patterns

Bulk creates secret scanning custom patterns for a repository.

"Bulk create repository custom patterns"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰은 필수 권한 집합을 포함해야 합니다.:

"Secret scanning alerts" repository permissions (write)

"Bulk create repository custom patterns"에 대한 매개 변수

머리글
이름, 유형, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, 유형, 설명
`owner` string 필수 The account owner of the repository. The name is not case sensitive.
`repo` string 필수 The name of the repository without the `.git` extension. The name is not case sensitive.

이름, 유형, 설명

patterns array of objects 필수

The list of custom patterns to create.

Properties of patterns

이름, 유형, 설명
`name` string 필수 The name of the custom pattern.
`pattern` string 필수 The regular expression of the custom pattern.
`start_delimiter` string The start delimiter regex for the custom pattern. Defaults to `\A\|[^0-9A-Za-z]` when not specified. 기본값: `\A\|[^0-9A-Za-z]`
`end_delimiter` string The end delimiter regex for the custom pattern. Defaults to `\z\|[^0-9A-Za-z]` when not specified. 기본값: `\z\|[^0-9A-Za-z]`
`must_match` array of strings List of regexes that the secret must match.
`must_not_match` array of strings List of regexes that the secret must not match.

"Bulk create repository custom patterns"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`201`	All patterns created successfully.
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed for one or more patterns.

"Bulk create repository custom patterns"에 대한 코드 샘플

GitHub에 GHE.com으로 액세스하는 경우, api.github.com를 api.SUBDOMAIN.ghe.com에 해당하는 귀하의 엔터프라이즈 전용 하위 도메인으로 교체하십시오.

요청 예제

post/repos/{owner}/{repo}/secret-scanning/custom-patterns

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/secret-scanning/custom-patterns \
  -d '{"patterns":[{"name":"Example Custom Pattern","pattern":"[a-z]+_token_[0-9]+"},{"name":"Another Custom Pattern","pattern":"prefix_[a-zA-Z0-9]{32}","start_delimiter":"\\b","end_delimiter":"\\b","must_match":["^prefix_prod"],"must_not_match":["test"]}]}'

All patterns created successfully.

Status: 201

{
  "created_patterns": [
    {
      "id": 1,
      "name": "Example Custom Pattern",
      "pattern": "[a-z]+_token_[0-9]+",
      "slug": "example-custom-pattern",
      "state": "unpublished",
      "push_protection_enabled": false,
      "start_delimiter": null,
      "end_delimiter": null,
      "must_match": null,
      "must_not_match": null,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    },
    {
      "id": 2,
      "name": "Another Custom Pattern",
      "pattern": "prefix_[a-zA-Z0-9]{32}",
      "slug": "another-custom-pattern",
      "state": "unpublished",
      "push_protection_enabled": false,
      "start_delimiter": "\\b",
      "end_delimiter": "\\b",
      "must_match": [
        "^prefix_prod"
      ],
      "must_not_match": [
        "test"
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Bulk delete repository custom patterns

Bulk deletes secret scanning custom patterns for a repository.

"Bulk delete repository custom patterns"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰은 필수 권한 집합을 포함해야 합니다.:

"Secret scanning alerts" repository permissions (write)

"Bulk delete repository custom patterns"에 대한 매개 변수

머리글
이름, 유형, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, 유형, 설명
`owner` string 필수 The account owner of the repository. The name is not case sensitive.
`repo` string 필수 The name of the repository without the `.git` extension. The name is not case sensitive.

이름, 유형, 설명

patterns array of objects 필수

The list of custom patterns to delete.

Properties of patterns

이름, 유형, 설명
`pattern_id` integer 필수 The ID of the custom pattern to delete.
`custom_pattern_version` string or null 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.

post_delete_action string

기본값: delete_alerts

다음 중 하나일 수 있습니다.: delete_alerts, resolve_alerts

"Bulk delete repository custom patterns"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`204`	All patterns deleted successfully.
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`412`	Precondition Failed

"Bulk delete repository custom patterns"에 대한 코드 샘플

GitHub에 GHE.com으로 액세스하는 경우, api.github.com를 api.SUBDOMAIN.ghe.com에 해당하는 귀하의 엔터프라이즈 전용 하위 도메인으로 교체하십시오.

요청 예제

delete/repos/{owner}/{repo}/secret-scanning/custom-patterns

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/secret-scanning/custom-patterns \
  -d '{"patterns":[{"pattern_id":2,"custom_pattern_version":"0ujsswThIGTUYm2K8FjOOfXtY1K"}]}'

All patterns deleted successfully.

Status: 204

Update a repository custom pattern

Updates a secret scanning custom pattern for a repository.

"Update a repository custom pattern"에 대한 세분화된 액세스 토큰

이 엔드포인트는 다음 세분화된 토큰 형식에서 작동합니다.:

세분화된 토큰은 필수 권한 집합을 포함해야 합니다.:

"Secret scanning alerts" repository permissions (write)

"Update a repository custom pattern"에 대한 매개 변수

머리글
이름, 유형, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, 유형, 설명
`owner` string 필수 The account owner of the repository. The name is not case sensitive.
`repo` string 필수 The name of the repository without the `.git` extension. The name is not case sensitive.
`pattern_id` integer 필수 The ID of the custom pattern.

본문 매개 변수
이름, 유형, 설명
`pattern` string The updated regular expression of the custom pattern.
`start_delimiter` string The updated start delimiter regex for the custom pattern.
`end_delimiter` string The updated end delimiter regex for the custom pattern.
`must_match` array of strings Updated list of regexes that the secret must match.
`must_not_match` array of strings Updated list of regexes that the secret must not match.
`custom_pattern_version` string or null 필수 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.

"Update a repository custom pattern"에 대한 HTTP 응답 상태 코드

상태 코드	설명
`200`	Pattern updated successfully.
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`412`	Precondition Failed
`422`	Validation failed, or the endpoint has been spammed.

"Update a repository custom pattern"에 대한 코드 샘플

GitHub에 GHE.com으로 액세스하는 경우, api.github.com를 api.SUBDOMAIN.ghe.com에 해당하는 귀하의 엔터프라이즈 전용 하위 도메인으로 교체하십시오.

요청 예제

patch/repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2026-03-10" \
  https://api.github.com/repos/OWNER/REPO/secret-scanning/custom-patterns/PATTERN_ID \
  -d '{"pattern":"updated_secret_[0-9A-Z]{16}","start_delimiter":"[^0-9A-Za-z]","end_delimiter":"[^0-9A-Za-z]","must_match":["updated_secret_[0-9]{2}*"],"must_not_match":["updated_secret_1234567890ABCDEF"],"custom_pattern_version":"0ujsswThIGTUYm2K8FjOOfXtY1K"}'

Pattern updated successfully.

Status: 200

{
  "id": 1,
  "name": "Example Custom Pattern",
  "pattern": "updated_secret_[0-9A-Z]{16}",
  "slug": "example_custom_pattern",
  "state": "published",
  "push_protection_enabled": true,
  "start_delimiter": "[^0-9A-Za-z]",
  "end_delimiter": "[^0-9A-Za-z]",
  "must_match": [
    "updated_secret_[0-9]{2}*"
  ],
  "must_not_match": [
    "updated_secret_1234567890ABCDEF"
  ],
  "custom_pattern_version": "0ujsswThIGTUYm2K8FjOOfXtY1K",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-06-01T12:00:00Z"
}