GIgithub
code-scanning

Get the AI Scan setting for an organization

Changed on

Gets the AI Scan setting stored on an organization.

The response reports the value stored on the organization. Organization respects enterprise policy.

The authenticated user must be an owner or security manager for the organization to use this endpoint.

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.

get/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.

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