Sample - GitHub REST API
PATCH/repos/{owner}/{repo}/code-scanning/default-setup

Update a code scanning default setup configuration

Updates a code scanning default setup configuration.

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 · 6 body fields
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.
statestringoptional
The desired state of code scanning default setup.
Allowed:configurednot-configured
runner_typestringoptional
Runner type to be used.
Allowed:standardlabeled
runner_labelstringoptional
Runner label to be used if the runner type is labeled.
query_suitestringoptional
CodeQL query suite to be used.
Allowed:defaultextended
threat_modelstringoptional
Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input.
Allowed:remoteremote_and_local
languagesarray<string>optional
CodeQL languages to be analyzed.

7 status codes
200Response
202Response
run_idintegeroptional
ID of the corresponding run.
run_urlstringoptional
URL of the corresponding run.
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
409Response if there is already a validation run in progress with a different default setup configuration
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Response if the configuration change cannot be made because the repository is not in the required state
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
503Service unavailable
codestringoptional
messagestringoptional
documentation_urlstringoptional

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 409 is returned: Response if there is already a validation run in progress with a different default setup configuration. A 422 is returned: Response if the configuration change cannot be made because the repository is not in the required state. A 503 is returned: Service unavailable.