POST /repos/{owner}/{repo}/secret-scanning/custom-patterns
Bulk creates 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.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
repo |
String | Yes |
The name of the repository without the |
owner |
String | Yes |
The account owner of the repository. The name is not case sensitive. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
patterns[] |
Array | Yes |
The list of custom patterns to create. |
patterns[].name |
String | Yes |
The name of the custom pattern. |
patterns[].must_match[] |
Array | No |
List of regexes that the secret must match. |
patterns[].end_delimiter |
String | No |
The end delimiter regex for the custom pattern.
Defaults to Default value: "\\z|[^0-9A-Za-z]" |
patterns[].start_delimiter |
String | No |
The start delimiter regex for the custom pattern.
Defaults to Default value: "\\A|[^0-9A-Za-z]" |
patterns[].pattern |
String | Yes |
The regular expression of the custom pattern. |
patterns[].must_not_match[] |
Array | No |
List of regexes that the secret must not match. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.