PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}
Updates the status of 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.
Servers
- https://api.github.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
repo |
String | Yes |
The name of the repository without the |
owner |
String | Yes |
The account owner of the repository. The name is not case sensitive. |
alert_number |
Integer | Yes |
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 |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
create_request |
Boolean | No |
If |
dismissed_reason |
String | No |
Required when the state is dismissed. The reason for dismissing or closing the alert. Possible values:
|
state |
String | Yes |
Sets the state of the code scanning alert. You must provide Possible values:
|
dismissed_comment |
String | No |
The dismissal comment associated with the dismissal of the alert. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.