Sample - GitHub REST API
POST/orgs/{org}/secret-scanning/custom-patterns

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.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 1 body field
orgstringrequired
The organization name. The name is not case sensitive.
patternsarray<SecretScanningCustomPatternToCreate>required
The list of custom patterns to create (maximum 100).

5 status codes
201All patterns created successfully.
created_patternsarray<SecretScanningCustomPattern>optional
The list of successfully created custom patterns.
400Bad Request
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
403Forbidden
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Validation failed for one or more patterns.
messagestringoptional
A summary message describing the error.
validation_errorsobjectoptional
A map of validation errors keyed by the zero-based index of the pattern that failed.

Error handling

A 400 is returned: Bad Request. A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 422 is returned: Validation failed for one or more patterns.