code-scanning

List dismissal requests for code scanning alerts for an organization

Lists dismissal requests for code scanning alerts for all repositories in an organization.

The user must be authorized to review dismissal requests for the organization. Personal access tokens (classic) need the security_events scope to use this endpoint.

get/orgs/{org}/dismissal-requests/code-scanning

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/orgs/{org}/dismissal-requests/code-scanning
  • Auth: none declared

Path parameters

orgstring required

The organization name. The name is not case sensitive.

Query parameters

reviewerstring

Filter alert dismissal requests by the handle of the GitHub user who reviewed the dismissal request.

requesterstring

Filter alert dismissal requests by the handle of the GitHub user who requested the dismissal.

time_period'hour' | 'day' | 'week' | 'month'

The time period to filter by.

For example, day will filter for rule suites that occurred in the past 24 hours, and week will filter for insights that occurred in the past 7 days (168 hours).

request_status'open' | 'approved' | 'expired' | 'denied' | 'all'

Filter alert dismissal requests by status. When specified, only requests with this status will be returned.

repository_namestring

The name of the repository to filter on.

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

pageinteger

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Response

A list of alert dismissal requests.

idinteger

The unique identifier of the dismissal request.

numberinteger

The number uniquely identifying the dismissal request within its repository.

request_typestring

The type of request.

resource_identifierstring

The unique identifier for the request type of the dismissal request.

status'pending' | 'denied' | 'approved' | 'expired'

The status of the dismissal request.

requester_commentstring nullable

The comment the requester provided when creating the dismissal request.

expires_atstring date-time

The date and time the dismissal request will expire.

created_atstring date-time

The date and time the dismissal request was created.

urlstring uri
html_urlstring uri

The URL to view the dismissal request in a browser.

Example response

[
  {
    "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132",
    "url": "https://api.github.com/repos/octo-org/smile/dismissal-requests/code-scanning/1",
    "html_url": "https://github.com/octo-org/smile/code-scanning/alerts/1"
  }
]

Changes

No recorded changes to this operation across all 83 revisions of this API.