REST API endpoints for secret scanning custom patterns

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.

Fine-grained access tokens for "List organization custom patterns"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Administration" organization permissions (read)

Parameters for "List organization custom patterns"

Headers
Name, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Path parameters
Name, Type, Description
`org` string Required The organization name. The name is not case sensitive.

Query parameters
Name, Type, Description
`state` string Filter custom patterns by state. When absent, returns patterns in all states. Can be one of: `published`, `unpublished`
`push_protection` string Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status. Can be one of: `enabled`, `disabled`
`sort` string The property to sort the results by. Default: `created` Can be one of: `created`, `updated`, `name`
`direction` string The direction to sort the results by. Default: `desc` Can be one of: `asc`, `desc`
`before` string A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."
`after` string A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

HTTP response status codes for "List organization custom patterns"

Status code	Description
`200`	OK
`403`	Forbidden
`404`	Resource not found

Code samples for "List organization custom patterns"

Request example

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.

Fine-grained access tokens for "Bulk create organization custom patterns"

This endpoint works with the following fine-grained token types:

The fine-grained token must have the following permission set:

"Administration" organization permissions (write)

Parameters for "Bulk create organization custom patterns"

Headers
Name, Type, Description
`accept` string