GitHub: Create a push protection bypass

← Secret scanning operations · Get started

Operation github.secret_scanning_create_push_protection_bypass

Provider route: POST /repos/{owner}/{repo}/secret-scanning/push-protection-bypasses. 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"]["secretScanningCreatePushProtectionBypass"]>[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.secretScanningCreatePushProtectionBypass(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_create_push_protection_bypass(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	object	Required within parent
body.placeholder_id	string	Required within parent	The ID of the push protection bypass placeholder. This value is returned on any push protected routes.
body.reason	string	Required within parent	The reason for bypassing push protection. One of: false_positive, used_in_tests, will_fix_later

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 Create a push protection bypass — response body

Referenced models: Create a push protection bypass — response body

Schemas

Create a push protection bypass — response body

Field	Type	Presence	Description and constraints
$	object	Root
expire_at	JSON	Optional
expire_at (anyOf 1)	string	Alternative	The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Format: date-time
expire_at (anyOf 2)	null	Alternative
reason	string	Optional	The reason for bypassing push protection. Known values: false_positive, used_in_tests, will_fix_later
token_type	string	Optional	The token type this bypass is for.

Policy, approvals and errors

SDK function policy ID: github.secret_scanning_create_push_protection_bypass. Catalog operation: secret-scanning/create-push-protection-bypass. 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