Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
octokit.secretScanning.getAlert({owner,repo,alert_number,});
| name | required | description |
|---|---|---|
| owner | yes | |
| repo | yes | |
| alert_number | yes | The security alert number, found at the end of the security alert's URL. |
See also: GitHub Developer Guide documentation.
Lists all secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.
GitHub Apps must have the secret_scanning_alerts read permission to use this endpoint.
octokit.secretScanning.listAlertsForRepo({owner,repo,});
| name | required | description |
|---|---|---|
| owner | yes | |
| repo | yes | |
| state | no | Set to |
| page | no | Page number of the results to fetch. |
| per_page | no | Results per page (max 100) |
See also: GitHub Developer Guide documentation.
Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the repo scope or security_events scope.
GitHub Apps must have the secret_scanning_alerts write permission to use this endpoint.
octokit.secretScanning.updateAlert({owner,repo,alert_number,state,});
| name | required | description |
|---|---|---|
| owner | yes | |
| repo | yes | |
| alert_number | yes | The security alert number, found at the end of the security alert's URL. |
| state | yes | Sets the state of the secret scanning alert. Can be either |
| resolution | no | Required when the |
See also: GitHub Developer Guide documentation.