PATCH /orgs/{org}/secret-scanning/custom-patterns/{pattern_id}
Updates a secret scanning custom pattern for an organization.
Personal access tokens (classic) need the write:org scope to use this endpoint.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
pattern_id |
Integer | Yes |
The ID of the custom pattern. |
org |
String | Yes |
The organization name. 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 |
|---|---|---|---|
must_match[] |
Array | No |
Updated list of regexes that the secret must match. |
end_delimiter |
String | No |
The updated end delimiter regex for the custom pattern. |
start_delimiter |
String | No |
The updated start delimiter regex for the custom pattern. |
pattern |
String | No |
The updated regular expression of the custom pattern. |
custom_pattern_version |
String | Yes |
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. |
must_not_match[] |
Array | No |
Updated 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.