POST /repos/{owner}/{repo}/code-scanning/codeql/variant-analyses
Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.
Get started by learning more about running CodeQL queries at scale with Multi-Repository Variant Analysis.
Use the owner and repo parameters in the URL to specify the controller repository that
will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.
OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
repo |
String | Yes |
The name of the repository without the |
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 |
|---|---|---|---|
repositories[] |
Array | No |
List of repository names (in the form |
repository_owners[] |
Array | No |
List of organization or user names whose repositories the query should be run against. Precisely one property from |
repository_lists[] |
Array | No |
List of repository lists to run the query against. Precisely one property from |
query_pack |
String | Yes |
A Base64-encoded tarball containing a CodeQL query and all its dependencies |
language |
String | Yes |
The language targeted by the CodeQL query Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.