GitHub: Bulk delete repository custom patterns

← Secret scanning operations · Get started

Operation github.secret_scanning_bulk_delete_repo_custom_patterns

Provider route: DELETE /repos/{owner}/{repo}/secret-scanning/custom-patterns. 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"]["secretScanningBulkDeleteRepoCustomPatterns"]>[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.secretScanningBulkDeleteRepoCustomPatterns(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_bulk_delete_repo_custom_patterns(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.owner	string	Required within parent
path.repo	string	Required within parent
body	Model	Required within parent	Expand Bulk delete repository custom patterns — request body — body

Referenced models: Bulk delete repository custom patterns — 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
$	null	Root

Schemas

Bulk delete repository custom patterns — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
patterns	array	Required within parent	The list of custom patterns to delete. Maximum items: 500
patterns[]	Model	Each item	Expand Bulk delete repository custom patterns — request body — body patterns item
post_delete_action	string	Optional	What to do with alerts associated with the deleted patterns. `delete_alerts` permanently removes the alerts. `resolve_alerts` resolves the alerts as "pattern deleted". Defaults to `delete_alerts` when not specified. Default: delete_alerts One of: delete_alerts, resolve_alerts

Referenced models: Bulk delete repository custom patterns — request body — body patterns item

Bulk delete repository custom patterns — request body — body patterns item

Field	Type	Presence	Description and constraints
$	object	Root	A custom pattern to delete in a bulk operation.
custom_pattern_version	Model	Optional	Expand Update a repository custom pattern — response body — custom pattern version
pattern_id	integer	Required within parent	The ID of the custom pattern to delete.

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_bulk_delete_repo_custom_patterns. Catalog operation: secret-scanning/bulk-delete-repo-custom-patterns. 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"}

No-content response statuses: [204]

Official provider source