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

Update AI Scan enablement for a repository

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

Updates whether AI Scan is enabled for a repository.

OAuth app tokens and personal access tokens (classic) need the repo 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 · 1 body field
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.
pr_scanstringoptional
Whether to enable or disable AI Scan for the repository.
Allowed:enableddisabled

4 status codes
200Response
pr_scanstringrequired
Whether AI Scan is enabled for the repository.
Allowed:enableddisabled
403Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Validation failed, or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<object>optional

Error handling

A 403 is returned: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository. A 404 is returned: Resource not found. A 422 is returned: Validation failed, or the endpoint has been spammed.