GitHub: Update status check protection

← Repos operations · Get started

Operation github.repos_update_status_check_protection

Provider route: PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks. 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["repos"]["reposUpdateStatusCheckProtection"]>[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.repos.reposUpdateStatusCheckProtection(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.repos.repos_update_status_check_protection(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
path.branch	string	Required within parent
body	object	Optional
body.checks	array	Optional	The list of status checks to require in order to merge into this branch.
body.checks[]	object	Each item
body.checks[].app_id	integer	Optional	The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.
body.checks[].context	string	Required within parent	The name of the required check
body.contexts	array	Optional	Closing down notice: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.
body.contexts[]	string	Each item
body.strict	boolean	Optional	Require branches to be up to date before merging.

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 Get status checks protection — response body

Referenced models: Get status checks protection — response body

Schemas

Get status checks protection — response body

Field	Type	Presence	Description and constraints
$	object	Root	Status Check Policy
checks	array	Required within parent
checks[]	object	Each item
checks[].app_id	JSON	Required within parent
checks[].app_id (anyOf 1)	JSON	Alternative
checks[].app_id (anyOf 1) (anyOf 1)	integer	Alternative
checks[].app_id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
checks[].app_id (anyOf 2)	null	Alternative
checks[].context	string	Required within parent
contexts	array	Required within parent
contexts[]	string	Each item
contexts_url	string	Required within parent	Format: uri
strict	boolean	Required within parent
url	string	Required within parent	Format: uri

Policy, approvals and errors

SDK function policy ID: github.repos_update_status_check_protection. Catalog operation: repos/update-status-check-protection. 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