PATCH /orgs/{org}/secret-scanning/pattern-configurations
Updates the secret scanning pattern configurations 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 |
|---|---|---|---|
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 |
|---|---|---|---|
custom_pattern_settings[] |
Array | No |
Pattern settings for custom patterns. |
custom_pattern_settings[].token_type |
String | No |
The ID of the pattern to configure. |
custom_pattern_settings[].custom_pattern_version |
String | No |
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. |
custom_pattern_settings[].push_protection_setting |
String | No |
Push protection setting to set for the pattern. Valid values:
|
provider_pattern_settings[] |
Array | No |
Pattern settings for provider patterns. |
provider_pattern_settings[].token_type |
String | No |
The ID of the pattern to configure. |
provider_pattern_settings[].push_protection_setting |
String | No |
Push protection setting to set for the pattern. Valid values:
|
pattern_config_version |
String | No |
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. |
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.