Sample - GitHub REST API
GET/repos/{owner}/{repo}/code-scanning/ai-scan

Get AI Scan enablement for a repository

[!NOTE] This endpoint is in public preview and is subject to change.

Gets whether AI Scan is enabled for a repository.

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.

3 status codes
200Response
pr_scanstringrequired
Whether AI Scan is enabled for the repository.
Allowed:enableddisabled
403Response if GitHub Advanced Security is not enabled for this repository
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 403 is returned: Response if GitHub Advanced Security is not enabled for this repository. A 404 is returned: Resource not found.