code-scanning

Get the status of an autofix for a code scanning alert

Changed on

Gets the status and description of an autofix for a code scanning alert on the repository's default branch.

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.

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

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix
  • Auth: none declared

Path parameters

ownerstring required

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

repostring required

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

alert_numberinteger required

The security alert number.

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.

Response

Response

status'pending' | 'error' | 'success' | 'outdated' required

The status of an autofix.

descriptionstring nullable required

The description of an autofix.

started_atstring date-time required

The start time of an autofix in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

Changes

  • 2022-11-282da668dda928Revision changes
    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status