GitHub API (unofficial showcase)
GET/repos/{owner}/{repo}/code-scanning/default-setup

Get a code scanning default setup configuration

Gets 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.

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.

4 status codes
200Response
statestringoptional
Code scanning default setup has been configured or not.
Allowed:configurednot-configured
languagesarray<string>optional
Languages to be analyzed.
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
updated_atstringoptional
Timestamp of latest configuration update.
schedulestringoptional
The frequency of the periodic analysis.
Allowed:weekly
403Response if GitHub Advanced Security is not enabled for this repository
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
503Service unavailable
codestringoptional
messagestringoptional
documentation_urlstringoptional

Error handling

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