GitHub: Update an organization custom pattern

GitHub secretScanning.secretScanningUpdateOrgCustomPattern: arguments, response, policy and SDK examples.

← Secret scanning operations · Get started

Operation github.secret_scanning_update_org_custom_pattern

Provider route: PATCH /orgs/{org}/secret-scanning/custom-patterns/{pattern_id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["secretScanning"]["secretScanningUpdateOrgCustomPattern"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.secretScanning.secretScanningUpdateOrgCustomPattern(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.secret_scanning.secret_scanning_update_org_custom_pattern(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.org`	string	Required within parent
`path.pattern_id`	integer	Required within parent
`body`	Model	Required within parent	Expand Update a repository custom pattern — request body — body

Referenced models: Update a repository custom pattern — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Update a repository custom pattern — response body

Referenced models: Update a repository custom pattern — response body

Schemas

Update a repository custom pattern — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A custom pattern for secret scanning.
`created_at`	string	Optional	The date and time the custom pattern was created in ISO 8601 format. Format: date-time
`custom_pattern_version`	Model	Optional	Expand Update a repository custom pattern — response body — custom pattern version
`end_delimiter`	JSON	Optional
`end_delimiter (anyOf 1)`	string	Alternative	The end delimiter regex for the custom pattern.
`end_delimiter (anyOf 2)`	null	Alternative
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	The ID of the custom pattern.
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`must_match`	JSON	Optional
`must_match (anyOf 1)`	array	Alternative	List of regexes that the secret must match.
`must_match (anyOf 1)[]`	string	Each item
`must_match (anyOf 2)`	null	Alternative
`must_not_match`	JSON	Optional
`must_not_match (anyOf 1)`	array	Alternative	List of regexes that the secret must not match.
`must_not_match (anyOf 1)[]`	string	Each item
`must_not_match (anyOf 2)`	null	Alternative
`name`	string	Required within parent	The name of the custom pattern.
`pattern`	string	Required within parent	The regular expression of the custom pattern.
`push_protection_enabled`	boolean	Required within parent	Whether push protection is enabled for this custom pattern.
`slug`	string	Required within parent	A URL-friendly identifier for the custom pattern, derived from its name.
`start_delimiter`	JSON	Optional
`start_delimiter (anyOf 1)`	string	Alternative	The start delimiter regex for the custom pattern.
`start_delimiter (anyOf 2)`	null	Alternative
`state`	string	Required within parent	The state of the custom pattern. Known values: published, unpublished
`updated_at`	string	Optional	The date and time the custom pattern was last updated in ISO 8601 format. Format: date-time

Referenced models: Update a repository custom pattern — response body — custom pattern version

Update a repository custom pattern — request body — body

Field	Type	Presence	Description and constraints
`$`	JSON	Root	Fields to update on a custom pattern. At least one updatable field (`pattern`, `start_delimiter`, `end_delimiter`, `must_match`, or `must_not_match`) must also be provided. Only provided fields will be updated.
`custom_pattern_version`	Model	Required within parent	Expand Update a repository custom pattern — response body — custom pattern version
`end_delimiter`	string	Optional	The updated end delimiter regex for the custom pattern.
`must_match`	array	Optional	Updated list of regexes that the secret must match.
`must_match[]`	string	Each item
`must_not_match`	array	Optional	Updated list of regexes that the secret must not match.
`must_not_match[]`	string	Each item
`pattern`	string	Optional	The updated regular expression of the custom pattern.
`start_delimiter`	string	Optional	The updated start delimiter regex for the custom pattern.
`$ (anyOf 1)`	JSON	Alternative
`$ (anyOf 2)`	JSON	Alternative
`$ (anyOf 3)`	JSON	Alternative
`$ (anyOf 4)`	JSON	Alternative
`$ (anyOf 5)`	JSON	Alternative

Referenced models: Update a repository custom pattern — response body — custom pattern version

Update a repository custom pattern — response body — custom pattern version

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	string	Alternative	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.
`$ (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: github.secret_scanning_update_org_custom_pattern. Catalog operation: secret-scanning/update-org-custom-pattern. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page