Skip to main content

codeql_databases

Overview

Namecodeql_databases
TypeResource
Idgithub.code_scanning.codeql_databases

Fields

NameDatatypeDescription
idintegerThe ID of the CodeQL database.
namestringThe name of the CodeQL database.
content_typestringThe MIME type of the CodeQL database file.
created_atstringThe date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
languagestringThe language of the CodeQL database.
sizeintegerThe size of the CodeQL database file in bytes.
updated_atstringThe date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
uploaderobjectA GitHub user.
urlstringThe URL at which to download the CodeQL database. The Accept header must be set to the value of the content_type property.

Methods

NameAccessible byRequired ParamsDescription
get_codeql_databaseSELECTlanguage, owner, repoGets 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 request
to application/zip, and make sure
your HTTP client is configured to follow redirects or use the Location header
to 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_databasesSELECTowner, repoLists 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.