codeql_databases
Overview
Name | codeql_databases |
Type | Resource |
Id | github.code_scanning.codeql_databases |
Fields
Name | Datatype | Description |
---|---|---|
id | integer | The ID of the CodeQL database. |
name | string | The name of the CodeQL database. |
content_type | string | The MIME type of the CodeQL database file. |
created_at | string | The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. |
language | string | The language of the CodeQL database. |
size | integer | The size of the CodeQL database file in bytes. |
updated_at | string | The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. |
uploader | object | A GitHub user. |
url | string | The URL at which to download the CodeQL database. The Accept header must be set to the value of the content_type property. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get_codeql_database | SELECT | language, owner, repo | Gets a CodeQL database for a language in a repository. By default this endpoint returns JSON metadata about the CodeQL database. To download the CodeQL database binary content, set the Accept header of the requestto application/zip , and make sureyour HTTP client is configured to follow redirects or use the Location headerto make a second request to get the redirect URL. For private repositories, you must use an access token with the security_events scope.For public repositories, you can use tokens with the security_events or public_repo scope.GitHub Apps must have the contents read permission to use this endpoint. |
list_codeql_databases | SELECT | owner, repo | Lists the CodeQL databases that are available in a repository. For private repositories, you must use an access token with the security_events scope.For public repositories, you can use tokens with the security_events or public_repo scope.GitHub Apps must have the contents read permission to use this endpoint. |