机密扫描

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

所有 GitHub 文档都是开源的。 看到错误或不清楚的内容了吗？ 提交拉取请求。

帮助我们创建出色的文档！

操作

输入搜索词以在 GitHub 文档中找到它。

机密扫描 - GitHub AE Docs

使用 REST API 从存储库中检索和更新机密警报。

快速入门

比较 GitHub 的 API

REST API 中的资源

Rate limits

媒体类型

身份验证

确保 API 凭据安全

故障排除

Libraries

议题事件类型

GitHub 事件类型

适用于 GitHub Apps 安装令牌的终结点

适用于 GitHub Apps 用户令牌的终结点

GitHub 应用的权限

概述

使用 API

使用 JavaScript 编写脚本

使用 Ruby 编写脚本

为用户发现资源

交付部署

将数据渲染为图形

处理注释

分页

构建 CI 服务器

最佳实践

入门 - Git 数据库

开始 - 检查

加密机密

Guides

Artifacts

权限

机密

自托管运行器组

自托管运行程序

工作流程作业

工作流运行

工作流

事件

通知

标星

关注中

活动

GitHub 应用

安装

OAuth 授权

Webhook

应用

分支

受保护的分支

检查运行

检查套件

检查

代码扫描

行为准则

协作者

邀请

提交

提交注释

提交状态

部署密钥

部署分支策略

部署

环境

部署状态

表情符号

管理统计

公告

审核日志

全局 Webhook

许可证

组织

预接收环境

用户

企业管理

Gists

注释

Blob

reference

标记

Trees

Git 数据库

Gitignore

问题

受理人

里程碑

时间线

Markdown

元数据

统计信息

指标

迁移

成员

外部协作者

Boards

卡片

Project boards

拉取

评价注释

审查请求

审阅

速率限制

反应

发行版本

发布资产

自动链接

前叉

Git LFS

存储库

搜索

Teams

讨论评论

讨论

外部组

关注者

GPG 密钥

Git SSH 密钥

https://api.github.com/repos/octocat/Hello-World/contents/{+path}

Hello-World

Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.
To use this endpoint, you must be a member of the enterprise, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a <a href="https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization">security manager</a>.

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

enterprise

Set to <code>open</code> or <code>resolved</code> to only list secret scanning alerts in a specific state.

state

A comma-separated list of secret types to return. By default all secret types are returned.
See "<a href="https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security">Secret scanning patterns</a>"
for a complete list of secret types.

secret_type

A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are <code>false_positive</code>, <code>wont_fix</code>, <code>revoked</code>, <code>pattern_edited</code>, <code>pattern_deleted</code> or <code>used_in_tests</code>.

resolution

The property to sort the results by. <code>created</code> means when the alert was created. <code>updated</code> means when the alert was updated or resolved.

sort

The direction to sort the results by.

direction

The number of results per page (max 100).

per_page

A cursor, as given in the <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers">Link header</a>. If specified, the query only searches for results before this cursor.

before

A cursor, as given in the <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers">Link header</a>. If specified, the query only searches for results after this cursor.

after

A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are <code>active</code>, <code>inactive</code>, and <code>unknown</code>.

validity

List secret scanning alerts for an enterprise

Lists secret scanning alerts for an eligible 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 <code>repo</code> scope or <code>security_events</code> scope.
GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.

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

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

Page number of the results to fetch.

page

Repository is public or secret scanning is disabled for the repository

List secret scanning alerts for a repository

The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.

The REST API URL of the code locations for this alert.

**Required when the `state` is `resolved`.** The reason for resolving the alert.

The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.

The type of secret that secret scanning detected.

Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.

The token status as of the latest validity check.

Gets a single secret scanning alert detected in an eligible repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope.
GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.

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 <code>number</code> field in the response from the <code>GET /repos/{owner}/{repo}/code-scanning/alerts</code> operation.

alert_number

Repository is public, or secret scanning is disabled for the repository, or the resource is not found

Get a secret scanning alert

Sets the state of the secret scanning alert. You must provide <code>resolution</code> when you set the state to <code>resolved</code>.

Required when the <code>state</code> is <code>resolved</code>. The reason for resolving the alert.

An optional comment when closing an alert. Cannot be updated or deleted. Must be <code>null</code> when changing <code>state</code> to <code>open</code>.

resolution_comment

Updates the status of a secret scanning alert in an eligible repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope.
GitHub Apps must have the <code>secret_scanning_alerts</code> write permission to use this endpoint.

Bad request, resolution comment is invalid or the resolution was not changed.

State does not match the resolution or resolution comment

Update a secret scanning alert

https://api.github.com/repos/octocat/Hello-World/issues/1347

https://github.com/community/community/discussions/39082

https://github.com/community/community/discussions/39082#discussion-4566270

https://api.github.com/repos/octocat/Hello-World/pull/2846

https://api.github.com/repos/octocat/Hello-World/pulls/2846

List of locations where the secret was detected

Lists all locations for a given secret scanning alert for an eligible repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope.
GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.