Update a secret scanning alert

PATCH

/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}

Updates the status of a secret scanning alert in an eligible repository.

The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo or 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.

リクエストパラメータ

パスパラメータ

リクエストボディパラメータapplication/json

例

レスポンス

🟢200OK

application/json

Response

ボディapplication/json

🟠400Bad Request

🟠404Record Not Found

🟠422Parameter Error

🔴503Service Unavailable

リクエストExample

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://service1.exmaple.com/repos///secret-scanning/alerts/' \
--header 'Content-Type: application/json' \
--data '{
    "state": "resolved",
    "resolution": "false_positive"
}'

レスポンスExample

200 - default

{
    "number": 42,
    "created_at": "2020-11-06T18:18:30Z",
    "url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42",
    "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42",
    "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations",
    "state": "resolved",
    "resolution": "used_in_tests",
    "resolved_at": "2020-11-16T22:42:07Z",
    "resolved_by": {
        "login": "monalisa",
        "id": 2,
        "node_id": "MDQ6VXNlcjI=",
        "avatar_url": "https://alambic.github.com/avatars/u/2?",
        "gravatar_id": "",
        "url": "https://api.github.com/users/monalisa",
        "html_url": "https://github.com/monalisa",
        "followers_url": "https://api.github.com/users/monalisa/followers",
        "following_url": "https://api.github.com/users/monalisa/following{/other_user}",
        "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions",
        "organizations_url": "https://api.github.com/users/monalisa/orgs",
        "repos_url": "https://api.github.com/users/monalisa/repos",
        "events_url": "https://api.github.com/users/monalisa/events{/privacy}",
        "received_events_url": "https://api.github.com/users/monalisa/received_events",
        "type": "User",
        "site_admin": true
    },
    "secret_type": "mailchimp_api_key",
    "secret_type_display_name": "Mailchimp API Key",
    "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
    "push_protection_bypassed": false,
    "resolution_comment": "Example comment"
}

更新日時 2025-06-12 06:47:19

Get a secret scanning alert

List locations for a secret scanning alert