PATCH /repos/{owner}/{repo}/code-scanning/default-setup

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.

Servers

Path parameters

Name Type Required Description
repo String Yes

The name of the repository without the .git extension. The name is not case sensitive.

owner String Yes

The account owner of the repository. The name is not case sensitive.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
query_suite String No

CodeQL query suite to be used.

Possible values:

  • "extended"
  • "default"
runner_label String No

Runner label to be used if the runner type is labeled.

state String No

The desired state of code scanning default setup.

Possible values:

  • "not-configured"
  • "configured"
runner_type String No

Runner type to be used.

Possible values:

  • "standard"
  • "labeled"
languages[] Array No

CodeQL languages to be analyzed.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.