Get a code scanning alert

GET

/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}

Gets a single code scanning alert.

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

API method documentation

Parameters

Path Parameters

owner

required

string

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

repo

required

string

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

alert_number

required

The security alert number.

integer

The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.

Responses

200

Response

application/json

object

number

required

The security alert number.

integer

created_at

required

The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

string format: date-time

updated_at

The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

string format: date-time

url

required

The REST API URL of the alert resource.

string format: uri

html_url

required

The GitHub URL of the alert resource.

string format: uri

instances_url

required

The REST API URL for fetching the list of instances for an alert.

string format: uri

state

required

State of a code scanning alert.

string

nullable

Allowed values: open dismissed fixed

fixed_at

The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

string format: date-time

nullable

dismissed_by

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

dismissed_at

required

The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

string format: date-time

nullable

dismissed_reason

required

Required when the state is dismissed. The reason for dismissing or closing the alert.

string

nullable

Allowed values: false positive won't fix used in tests

dismissed_comment

The dismissal comment associated with the dismissal of the alert.

string

nullable <= 280 characters

rule

required

object

A unique identifier for the rule used to detect the alert.

string

nullable

name

The name of the rule used to detect the alert.

string

severity

The severity of the alert.

string

nullable

Allowed values: none note warning error

security_severity_level

The security severity of the alert.

string

nullable

Allowed values: low medium high critical

description

A short description of the rule used to detect the alert.

string

full_description

A description of the rule used to detect the alert.

string

tags

A set of tags applicable for the rule.

Array<string>

nullable

help

Detailed documentation for the rule as GitHub Flavored Markdown.

string

nullable

help_uri

A link to the documentation for the rule used to detect the alert.

string

nullable

tool

required

object

name

The name of the tool used to generate the code scanning analysis.

string

version

The version of the tool used to generate the code scanning analysis.

string

nullable

guid

The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.

string

nullable

most_recent_instance

required

object

ref

The Git reference, formatted as refs/pull/<number>/merge, refs/pull/<number>/head, refs/heads/<branch name> or simply <branch name>.

string

analysis_key

Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.

string

environment

Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.

string

category

Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.

string

state

State of a code scanning alert.

string

nullable

Allowed values: open dismissed fixed

commit_sha

string

message

object

text

string

markdown

The message text as GitHub-flavored Markdown, with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance.

string

location

Describe a region within a file for the alert.

object

path

string

start_line

integer

end_line

integer

start_column

integer

end_column

integer

html_url

string

classifications

Classifications that have been applied to the file that triggered the alert. For example identifying it as documentation, or a generated file.

Array<string>

Allowed values: source generated test library

dismissal_approved_by

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

assignees

Array<object>

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

linked_pull_requests

Pull requests linked to this alert.

Array<object>

Pull Request Simple

Pull Request Simple

object

url

required

string format: uri

required

integer format: int64

node_id

required

string

html_url

required

string format: uri

diff_url

required

string format: uri

patch_url

required

string format: uri

issue_url

required

string format: uri

commits_url

required

string format: uri

review_comments_url

required

string format: uri

review_comment_url

required

string

comments_url

required

string format: uri

statuses_url

required

string format: uri

number

required

integer

state

required

string

locked

required

boolean

title

required

string

user

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

body

required

string

nullable

labels

required

Array<object>

object

required

integer format: int64

node_id

required

string

url

required

string

name

required

string

description

required

string

color

required

string

default

required

boolean

milestone

required

Milestone

A collection of related issues and pull requests.

object

url

required

string format: uri

html_url

required

string format: uri

labels_url

required

string format: uri

required

integer

node_id

required

string

number

required

The number of the milestone.

integer

state

required

The state of the milestone.

string

default: open

Allowed values: open closed

title

required

The title of the milestone.

string

description

required

string

nullable

creator

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

open_issues

required

integer

closed_issues

required

integer

created_at

required

string format: date-time

updated_at

required

string format: date-time

closed_at

required

string format: date-time

nullable

due_on

required

string format: date-time

nullable

active_lock_reason

string

nullable

created_at

required

string format: date-time

updated_at

required

string format: date-time

closed_at

required

string format: date-time

nullable

merged_at

required

string format: date-time

nullable

merge_commit_sha

required

string

nullable

assignee

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

assignees

Array<object>

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

requested_reviewers

Array<object>

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

requested_teams

Array<object>

Team

Groups of organization members that gives permissions on specified repositories.

object

required

integer

node_id

required

string

name

required

string

slug

required

string

description

required

string

nullable

privacy

string

notification_setting

string

permission

required

string

permissions

object

pull

required

boolean

triage

required

boolean

push

required

boolean

maintain

required

boolean

admin

required

boolean

url

required

string format: uri

html_url

required

string format: uri

members_url

required

string

repositories_url

required

string format: uri

type

required

The ownership type of the team

string

Allowed values: enterprise organization

access_source

How the team’s access to the repository was granted. This property is only present when the team is returned in a repository context, such as GET /repos/{owner}/{repo}/teams.

string

Allowed values: direct organization enterprise

organization_id

Unique identifier of the organization to which this team belongs

integer

enterprise_id

Unique identifier of the enterprise to which this team belongs

integer

parent

required

Team Simple

Groups of organization members that gives permissions on specified repositories.

object

required

Unique identifier of the team

integer

node_id

required

string

url

required

URL for the team

string format: uri

members_url

required

string

name

required

Name of the team

string

description

required

Description of the team

string

nullable

permission

required

Permission that the team will have for its repositories

string

privacy

The level of privacy this team should have

string

notification_setting

The notification setting the team has set

string

html_url

required

string format: uri

repositories_url

required

string format: uri

slug

required

string

ldap_dn

Distinguished Name (DN) that team maps to within LDAP environment

string

type

required

The ownership type of the team

string

Allowed values: enterprise organization

organization_id

Unique identifier of the organization to which this team belongs

integer

enterprise_id

Unique identifier of the enterprise to which this team belongs

integer

head

required

object

label

required

string

ref

required

string

repo

required

Repository

A repository on GitHub.

object

required

Unique identifier of the repository

integer format: int64

node_id

required

string

name

required

The name of the repository.

string

full_name

required

string

license

required

License Simple

License Simple

object

key

required

string

name

required

string

url

required

string format: uri

nullable

spdx_id

required

string

nullable

node_id

required

string

html_url

string format: uri

forks

required

integer

permissions

object

admin

required

boolean

pull

required

boolean

triage

boolean

push

required

boolean

maintain

boolean

owner

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

private

required

Whether the repository is private or public.

boolean

html_url

required

string format: uri

description

required

string

nullable

fork

required

boolean

url

required

string format: uri

archive_url

required

string

assignees_url

required

string

blobs_url

required

string

branches_url

required

string

collaborators_url

required

string

comments_url

required

string

commits_url

required

string

compare_url

required

string

contents_url

required

string

contributors_url

required

string format: uri

deployments_url

required

string format: uri

downloads_url

required

string format: uri

events_url

required

string format: uri

forks_url

required

string format: uri

git_commits_url

required

string

git_refs_url

required

string

git_tags_url

required

string

git_url

required

string

issue_comment_url

required

string

issue_events_url

required

string

issues_url

required

string

keys_url

required

string

labels_url

required

string

languages_url

required

string format: uri

merges_url

required

string format: uri

milestones_url

required

string

notifications_url

required

string

pulls_url

required

string

releases_url

required

string

ssh_url

required

string

stargazers_url

required

string format: uri

statuses_url

required

string

subscribers_url

required

string format: uri

subscription_url

required

string format: uri

tags_url

required

string format: uri

teams_url

required

string format: uri

trees_url

required

string

clone_url

required

string

mirror_url

required

string format: uri

nullable

hooks_url

required

string format: uri

svn_url

required

string format: uri

homepage

required

string format: uri

nullable

language

required

string

nullable

forks_count

required

integer

stargazers_count

required

integer

watchers_count

required

integer

size

required

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

integer

default_branch

required

The default branch of the repository.

string

open_issues_count

required

integer

is_template

Whether this repository acts as a template that can be used to generate new repositories.

boolean

topics

Array<string>

has_issues

required

Whether issues are enabled.

boolean

default: true

has_projects

required

Whether projects are enabled.

boolean

default: true

has_wiki

required

Whether the wiki is enabled.

boolean

default: true

has_pages

required

boolean

has_downloads

required

Whether downloads are enabled.

boolean

default: true

has_discussions

Whether discussions are enabled.

boolean

has_pull_requests

Whether pull requests are enabled.

boolean

default: true

pull_request_creation_policy

The policy controlling who can create pull requests: all or collaborators_only.

string

Allowed values: all collaborators_only

archived

required

Whether the repository is archived.

boolean

disabled

required

Returns whether or not this repository disabled.

boolean

visibility

The repository visibility: public, private, or internal.

string

default: public

pushed_at

required

string format: date-time

nullable

created_at

required

string format: date-time

nullable

updated_at

required

string format: date-time

nullable

allow_rebase_merge

Whether to allow rebase merges for pull requests.

boolean

default: true

temp_clone_token

string

allow_squash_merge

Whether to allow squash merges for pull requests.

boolean

default: true

allow_auto_merge

Whether to allow Auto-merge to be used on pull requests.

boolean

delete_branch_on_merge

Whether to delete head branches when pull requests are merged

boolean

allow_update_branch

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

boolean

use_squash_pr_title_as_default

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

boolean

squash_merge_commit_title

The default value for a squash merge commit title:

PR_TITLE - default to the pull request’s title.
COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).

string

Allowed values: PR_TITLE COMMIT_OR_PR_TITLE

squash_merge_commit_message

The default value for a squash merge commit message:

PR_BODY - default to the pull request’s body.
COMMIT_MESSAGES - default to the branch’s commit messages.
BLANK - default to a blank commit message.

string

Allowed values: PR_BODY COMMIT_MESSAGES BLANK

merge_commit_title

The default value for a merge commit title.

PR_TITLE - default to the pull request’s title.
MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).

string

Allowed values: PR_TITLE MERGE_MESSAGE

merge_commit_message

The default value for a merge commit message.

PR_TITLE - default to the pull request’s title.
PR_BODY - default to the pull request’s body.
BLANK - default to a blank commit message.

string

Allowed values: PR_BODY PR_TITLE BLANK

allow_merge_commit

Whether to allow merge commits for pull requests.

boolean

default: true

allow_forking

Whether to allow forking this repo

boolean

web_commit_signoff_required

Whether to require contributors to sign off on web-based commits

boolean

open_issues

required

integer

watchers

required

integer

master_branch

string

starred_at

string

anonymous_access_enabled

Whether anonymous git access is enabled for this repository

boolean

code_search_index_status

The status of the code search index for this repository

object

lexical_search_ok

boolean

lexical_commit_sha

string

sha

required

string

user

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

base

required

object

label

required

string

ref

required

string

repo

required

Repository

A repository on GitHub.

object

required

Unique identifier of the repository

integer format: int64

node_id

required

string

name

required

The name of the repository.

string

full_name

required

string

license

required

License Simple

License Simple

object

key

required

string

name

required

string

url

required

string format: uri

nullable

spdx_id

required

string

nullable

node_id

required

string

html_url

string format: uri

forks

required

integer

permissions

object

admin

required

boolean

pull

required

boolean

triage

boolean

push

required

boolean

maintain

boolean

owner

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

private

required

Whether the repository is private or public.

boolean

html_url

required

string format: uri

description

required

string

nullable

fork

required

boolean

url

required

string format: uri

archive_url

required

string

assignees_url

required

string

blobs_url

required

string

branches_url

required

string

collaborators_url

required

string

comments_url

required

string

commits_url

required

string

compare_url

required

string

contents_url

required

string

contributors_url

required

string format: uri

deployments_url

required

string format: uri

downloads_url

required

string format: uri

events_url

required

string format: uri

forks_url

required

string format: uri

git_commits_url

required

string

git_refs_url

required

string

git_tags_url

required

string

git_url

required

string

issue_comment_url

required

string

issue_events_url

required

string

issues_url

required

string

keys_url

required

string

labels_url

required

string

languages_url

required

string format: uri

merges_url

required

string format: uri

milestones_url

required

string

notifications_url

required

string

pulls_url

required

string

releases_url

required

string

ssh_url

required

string

stargazers_url

required

string format: uri

statuses_url

required

string

subscribers_url

required

string format: uri

subscription_url

required

string format: uri

tags_url

required

string format: uri

teams_url

required

string format: uri

trees_url

required

string

clone_url

required

string

mirror_url

required

string format: uri

nullable

hooks_url

required

string format: uri

svn_url

required

string format: uri

homepage

required

string format: uri

nullable

language

required

string

nullable

forks_count

required

integer

stargazers_count

required

integer

watchers_count

required

integer

size

required

The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.

integer

default_branch

required

The default branch of the repository.

string

open_issues_count

required

integer

is_template

Whether this repository acts as a template that can be used to generate new repositories.

boolean

topics

Array<string>

has_issues

required

Whether issues are enabled.

boolean

default: true

has_projects

required

Whether projects are enabled.

boolean

default: true

has_wiki

required

Whether the wiki is enabled.

boolean

default: true

has_pages

required

boolean

has_downloads

required

Whether downloads are enabled.

boolean

default: true

has_discussions

Whether discussions are enabled.

boolean

has_pull_requests

Whether pull requests are enabled.

boolean

default: true

pull_request_creation_policy

The policy controlling who can create pull requests: all or collaborators_only.

string

Allowed values: all collaborators_only

archived

required

Whether the repository is archived.

boolean

disabled

required

Returns whether or not this repository disabled.

boolean

visibility

The repository visibility: public, private, or internal.

string

default: public

pushed_at

required

string format: date-time

nullable

created_at

required

string format: date-time

nullable

updated_at

required

string format: date-time

nullable

allow_rebase_merge

Whether to allow rebase merges for pull requests.

boolean

default: true

temp_clone_token

string

allow_squash_merge

Whether to allow squash merges for pull requests.

boolean

default: true

allow_auto_merge

Whether to allow Auto-merge to be used on pull requests.

boolean

delete_branch_on_merge

Whether to delete head branches when pull requests are merged

boolean

allow_update_branch

Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.

boolean

use_squash_pr_title_as_default

Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use squash_merge_commit_title instead.

boolean

squash_merge_commit_title

The default value for a squash merge commit title:

PR_TITLE - default to the pull request’s title.
COMMIT_OR_PR_TITLE - default to the commit’s title (if only one commit) or the pull request’s title (when more than one commit).

string

Allowed values: PR_TITLE COMMIT_OR_PR_TITLE

squash_merge_commit_message

The default value for a squash merge commit message:

PR_BODY - default to the pull request’s body.
COMMIT_MESSAGES - default to the branch’s commit messages.
BLANK - default to a blank commit message.

string

Allowed values: PR_BODY COMMIT_MESSAGES BLANK

merge_commit_title

The default value for a merge commit title.

PR_TITLE - default to the pull request’s title.
MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).

string

Allowed values: PR_TITLE MERGE_MESSAGE

merge_commit_message

The default value for a merge commit message.

PR_TITLE - default to the pull request’s title.
PR_BODY - default to the pull request’s body.
BLANK - default to a blank commit message.

string

Allowed values: PR_BODY PR_TITLE BLANK

allow_merge_commit

Whether to allow merge commits for pull requests.

boolean

default: true

allow_forking

Whether to allow forking this repo

boolean

web_commit_signoff_required

Whether to require contributors to sign off on web-based commits

boolean

open_issues

required

integer

watchers

required

integer

master_branch

string

starred_at

string

anonymous_access_enabled

Whether anonymous git access is enabled for this repository

boolean

code_search_index_status

The status of the code search index for this repository

object

lexical_search_ok

boolean

lexical_commit_sha

string

sha

required

string

user

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

_links

required

object

comments

required

Link

Hypermedia Link

object

href

required

string

commits

required

Link

Hypermedia Link

object

href

required

string

statuses

required

Link

Hypermedia Link

object

href

required

string

html

required

Link

Hypermedia Link

object

href

required

string

issue

required

Link

Hypermedia Link

object

href

required

string

review_comments

required

Link

Hypermedia Link

object

href

required

string

review_comment

required

Link

Hypermedia Link

object

href

required

string

self

required

Link

Hypermedia Link

object

href

required

string

author_association

required

author_association

How the author is associated with the repository.

string

Allowed values: COLLABORATOR CONTRIBUTOR FIRST_TIMER FIRST_TIME_CONTRIBUTOR MANNEQUIN MEMBER NONE OWNER

auto_merge

required

Auto merge

The status of auto merging a pull request.

object

enabled_by

required

Simple User

A GitHub user.

object

name

string

nullable

email

string

nullable

login

required

string

required

integer format: int64

node_id

required

string

avatar_url

required

string format: uri

gravatar_id

required

string

nullable

url

required

string format: uri

html_url

required

string format: uri

followers_url

required

string format: uri

following_url

required

string

gists_url

required

string

starred_url

required

string

subscriptions_url

required

string format: uri

organizations_url

required

string format: uri

repos_url

required

string format: uri

events_url

required

string

received_events_url

required

string format: uri

type

required

string

site_admin

required

boolean

starred_at

string

user_view_type

string

merge_method

required

The merge method to use.

string

Allowed values: merge squash rebase

commit_title

required

Title for the merge commit message.

string

commit_message

required

Commit message for the merge commit.

string

stack

Pull Request Stack

The stack information associated with a pull request.

object

base

required

object

ref

required

The base ref of the stack this pull request belongs to.

string

sha

required

The base SHA of the stack this pull request belongs to.

string

size

The total number of pull requests in the stack.

integer

position

The one-based position of this pull request within the stack, where 1 is the bottom of the stack.

integer

The ID of the stack that this pull request belongs to.

integer

number

The number of the stack that this pull request belongs to.

integer

draft

Indicates whether or not the pull request is a draft.

boolean

Examples

default

{
  "number": 42,
  "created_at": "2020-06-19T11:21:34Z",
  "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42",
  "html_url": "https://github.com/octocat/hello-world/code-scanning/42",
  "state": "dismissed",
  "fixed_at": null,
  "dismissed_by": {
    "login": "octocat",
    "id": 54933897,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  "dismissed_at": "2020-02-14T12:29:18Z",
  "dismissed_reason": "false positive",
  "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
  "rule": {
    "id": "js/zipslip",
    "severity": "error",
    "security_severity_level": "high",
    "description": "Arbitrary file write during zip extraction (\"Zip Slip\")",
    "name": "js/zipslip",
    "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.",
    "tags": [
      "security",
      "external/cwe/cwe-022"
    ],
    "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...",
    "help_uri": "https://codeql.github.com/"
  },
  "tool": {
    "name": "CodeQL",
    "guid": null,
    "version": "2.4.0"
  },
  "most_recent_instance": {
    "ref": "refs/heads/main",
    "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
    "category": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
    "environment": "{}",
    "state": "dismissed",
    "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
    "message": {
      "text": "This path depends on a user-provided value."
    },
    "location": {
      "path": "spec-main/api-session-spec.ts",
      "start_line": 917,
      "end_line": 917,
      "start_column": 7,
      "end_column": 18
    },
    "classifications": [
      "test"
    ]
  },
  "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances"
}

304

Not modified

403

Response if GitHub Advanced Security is not enabled for this repository

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

503

Service unavailable

application/json

object

code

string

message

string

documentation_url

string

Example^generated

{
  "code": "example",
  "message": "example",
  "documentation_url": "example"
}

Get a code scanning alert

Parameters

Path Parameters

Responses

200

Examples

304

403

Examplegenerated

404

Examplegenerated

503

Examplegenerated

Example^generated

Example^generated

Example^generated