GET /repos/{owner}/{repo}/secret-scanning/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.
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. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
Integer | No |
The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default value: 1 |
direction |
String | No |
The direction to sort the results by. Valid values:
Default value: "desc" |
sort |
String | No |
The property to sort the results by. Valid values:
Default value: "created" |
per_page |
Integer | No |
The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default value: 30 |
push_protection |
String | No |
Filter custom patterns by whether push protection is enabled. When absent, returns patterns regardless of push protection status. Valid values:
|
state |
String | No |
Filter custom patterns by state. When absent, returns patterns in all states. Valid values:
|
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.