GIgithub
code-scanning

Update the AI Scan setting for an organization

Changed on

Updates the AI Scan setting stored on an organization.

The organization respects the enterprise policy, so enabling is rejected when the enterprise disallows AI Scan.

OAuth app tokens and personal access tokens (classic) need the admin:org, repo, or write:org scope to use this endpoint. Organization owners can use admin:org or repo; security managers need write:org.

patch/orgs/{org}/code-scanning/ai-scan

Request

  • Base URL
    https://api.github.com
  • URL
    https://api.github.com/orgs/{org}/code-scanning/ai-scan
  • Auth
    none declared

Path parameters

orgstring required

The organization name. The name is not case sensitive.

Request body

pr_scan'enabled' | 'disabled'

Whether AI Scan is enabled for the organization. Organization respects enterprise policy. Disabled organizations prevent repositories from enabling AI Scan. Enabled organizations enable AI Scan for their repositories, but individual repositories can opt out.

Example request

{
  "pr_scan": "enabled"
}

Response

Response

pr_scan'enabled' | 'disabled' required

Whether AI Scan on pull requests is enabled for the organization. The organization setting respects enterprise policy, and repositories inherit it: when disabled, repositories cannot enable AI Scan; when enabled, repositories can still opt out.

Example response

{
  "pr_scan": "enabled"
}

Changes