PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number}

The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "Granting access to security alerts."

OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.

Servers

Path parameters

Name Type Required Description
repo String Yes

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

owner String Yes

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

alert_number Integer Yes

The number that identifies a Dependabot alert in its repository. You can find this at the end of the URL for a Dependabot alert within GitHub, or in number fields in the response from the GET /repos/{owner}/{repo}/dependabot/alerts operation.

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
dismissed_reason String No

Required when state is dismissed. A reason for dismissing the alert.

Possible values:

  • "tolerable_risk"
  • "no_bandwidth"
  • "fix_started"
  • "not_used"
  • "inaccurate"
state String Yes

The state of the Dependabot alert. A dismissed_reason must be provided when setting the state to dismissed.

Possible values:

  • "open"
  • "dismissed"
dismissed_comment String No

An optional comment associated with dismissing the alert.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.