Github API - Test Config

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

Lists code scanning alerts.

To use this endpoint, you must use an access token with the security_events scope or, for alerts from public repositories only, an access token with the public_repo scope.

GitHub Apps must have the security_events read
permission to use this endpoint.

The response includes a most_recent_instance object.
This provides details of the most recent instance of this alert
for the default branch (or for the specified Git reference if you used ref in the request).
List code scanning alerts for a repository

Arguments
key owner

owner [scalar]

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

API:
Github Open API
(version: 1.1.4)

key repo

repo [scalar]

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

API:
Github Open API
(version: 1.1.4)

key tool-name

tool-name [scalar]

The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.

API:
Github Open API
(version: 1.1.4)

key tool-guid

tool-guid [scalar]

The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.

API:
Github Open API
(version: 1.1.4)

key page

page [scalar]

Page number of the results to fetch.

API:
Github Open API
(version: 1.1.4)

key per-page

per-page [scalar]

The number of results per page (max 100).

API:
Github Open API
(version: 1.1.4)

key git-ref

git-ref [scalar]

The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

API:
Github Open API
(version: 1.1.4)

key direction

direction [scalar]

The direction to sort the results by.

API:
Github Open API
(version: 1.1.4)

sort string

string [scalar]

The OpenAPI string type

API:
Github Open API
(version: 1.1.4)

state code-scanning-alert-state

code-scanning-alert-state [scalar]

State of a code scanning alert.

API:
Github Open API
(version: 1.1.4)

severity code-scanning-alert-severity

code-scanning-alert-severity [scalar]

Severity of a code scanning alert.

API:
Github Open API
(version: 1.1.4)

Returns
200 application/json code-scanning-alert-items []

code-scanning-alert-items [object]

Attributes
created_at alert-created-at

dismissed_at alert-dismissed-at

dismissed_by nullable-simple-user

fixed_at alert-fixed-at

html_url alert-html-url

instances_url alert-instances-url

most_recent_instance code-scanning-alert-instance

number alert-number

updated_at alert-updated-at

url alert-url

API:
Github Open API
(version: 1.1.4)
304 not_modified

not_modified [scalar]

Not modified

API:
Github Open API
(version: 1.1.4)
403 code_scanning_forbidden_read

code_scanning_forbidden_read [scalar]

Response if GitHub Advanced Security is not enabled for this repository

API:
Github Open API
(version: 1.1.4)
404 not_found

not_found [scalar]

Resource not found

API:
Github Open API
(version: 1.1.4)
503 service_unavailable

service_unavailable [scalar]

Service unavailable

API:
Github Open API
(version: 1.1.4)
API:
Github Open API
(version: 1.1.4)