Skip to content

GitHub: Set the Copilot code review runner configuration for an organization

GitHub copilot.copilotSetOrganizationCodeReviewRunner: arguments, response, policy and SDK examples.

← Copilot operations · Get started

Operation github.copilot_set_organization_code_review_runner

Provider route: PUT /orgs/{org}/copilot/code-review/runner. Alter supplies the connection’s credentials and routing.

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["copilot"]["copilotSetOrganizationCodeReviewRunner"]>[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.copilot.copilotSetOrganizationCodeReviewRunner(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.copilot.copilot_set_organization_code_review_runner(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.orgstringRequired within parent
bodyobjectRequired within parentAdditional keys: not allowed
body.allow_repository_customizationbooleanOptionalWhether repositories can use their own runner configuration.
body.runner_group_nameJSONOptional
body.runner_group_name (anyOf 1)stringAlternativeThe runner group for a labeled runner.
body.runner_group_name (anyOf 2)nullAlternative
body.runner_labelsJSONOptional
body.runner_labels (anyOf 1)arrayAlternativeThe runner labels for a labeled runner.
body.runner_labels (anyOf 1)[]stringEach item
body.runner_labels (anyOf 2)nullAlternative
body.runner_typestringRequired within parentThe type of runner. `standard` uses GitHub-hosted runners. `labeled` uses runners that match the labels or runner group.
One of: standard, labeled

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get the Copilot code review runner configuration for an organization — response body

Referenced models: Get the Copilot code review runner configuration for an organization — response body

Get the Copilot code review runner configuration for an organization — response body
FieldTypePresenceDescription and constraints
$objectRootThe effective runner configuration that Copilot code review uses for the organization.
allow_repository_customizationbooleanRequired within parentWhether repositories can use their own runner configuration.
configured_bystringRequired within parentWhich configuration the values come from. `code_review` means the organization has saved a Copilot code review runner configuration. `coding_agent` means it has not, and the values are inherited from the organization's Copilot coding agent runner configuration.
Known values: code_review, coding_agent
runner_group_nameJSONRequired within parent
runner_group_name (anyOf 1)stringAlternativeThe runner group used for a labeled runner, or null when none is set.
runner_group_name (anyOf 2)nullAlternative
runner_labelsarrayRequired within parentThe runner labels used for a labeled runner.
runner_labels[]stringEach item
runner_typestringRequired within parentThe type of runner. `standard` uses GitHub-hosted runners. `labeled` uses runners that match the configured labels or runner group.
Known values: standard, labeled

SDK function policy ID: github.copilot_set_organization_code_review_runner. Catalog operation: copilot/set-organization-code-review-runner. 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

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.