secret-scanning

List enterprise custom patterns

Changed on

Lists secret scanning custom patterns for an enterprise.

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

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

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/enterprises/{enterprise}/secret-scanning/custom-patterns
  • Auth: none declared

Path parameters

enterprisestring required

The slug version of the enterprise name.

Query parameters

state'published' | 'unpublished'

Filter custom patterns by state. When absent, returns patterns in all states.

push_protection'enabled' | 'disabled'

Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status.

sort'created' | 'updated' | 'name'

The property to sort the results by.

direction'asc' | 'desc'

The direction to sort the results by.

beforestring

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."

afterstring

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."

Response

Response

idinteger required

The ID of the custom pattern.

namestring required

The name of the custom pattern.

patternstring required

The regular expression of the custom pattern.

slugstring required

A URL-friendly identifier for the custom pattern, derived from its name.

state'published' | 'unpublished' required

The state of the custom pattern.

push_protection_enabledboolean required

Whether push protection is enabled for this custom pattern.

start_delimiterstring nullable

The start delimiter regex for the custom pattern.

end_delimiterstring nullable

The end delimiter regex for the custom pattern.

must_matchstring[] nullable

List of regexes that the secret must match.

must_not_matchstring[] nullable

List of regexes that the secret must not match.

custom_pattern_versionstring 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.

created_atstring date-time

The date and time the custom pattern was created in ISO 8601 format.

updated_atstring date-time

The date and time the custom pattern was last updated in ISO 8601 format.

Changes

  • 2022-11-28cb7b1b79509eRevision changes
    • warning

      deleted the query request parameter page

    • warning

      deleted the query request parameter per_page

  • 2022-11-286db9777d2857Revision changes
    • info

      added the new optional query request parameter after

    • info

      added the new optional query request parameter before