Verificação de segredo

Enterprise Cloud

Enterprise Server

Enterprise Server 3.10

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

Toda a documentação do GitHub é de código aberto. Encontrou informações erradas ou confusas? Envie uma solicitação de pull.

Ajude-nos a tornar esses documentos ótimos!

Obtenha ajuda, onde quer que você esteja em sua jornada no GitHub.

Pode ser um dos

Nome

Parâmetros do corpo da solicitação do webhook

Todos os guias de {{ name }}

Roteiros de aprendizagem de {{ name }}

Ações

O GitHub começou a implantar essas alterações para empresas

Digite um termo de pesquisa a encontrar na Documentação do GitHub.

Verificação de segredo - GitHub AE Docs

Use a API REST para recuperar e atualizar os alertas de segredos de um repositório.

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

Início Rápido

Sobre as APIs do GitHub

Recursos na API REST

Tipos de mídia

Autenticação

Manter credenciais de API seguras

Solução de problemas

Bibliotecas

Tipos de eventos de problemas

Tipos de eventos do GitHub

Pontos de extremidade para tokens de instalação do aplicativo GitHub

Pontos de extremidade para tokens de usuário do aplicativo GitHub

Permissões para aplicativos GitHub

Visão geral

Usando a API

Script com JavaScript

Descobrir recursos para um usuário

Entregar implantações

Representar dados como gráficos

Trabalhar com comentários

Paginação

Criar um servidor de CI

Práticas recomendadas

Introdução – banco de dados Git

Introdução – Verificações

Criptografar segredos

Guides

Artifacts

Permissões

Segredos

Grupos de runner auto-hospedados

Executores auto-hospedados

Trabalhos de fluxo de trabalho

Execução de fluxo de trabalho

Fluxos de trabalho

Eventos

Feeds

Notificações

Marcar com uma estrela

Observando

Atividade

Aplicativos GitHub

Instalações

Autorizações do OAuth

Webhooks

Aplicativos

Branches

Branches protegidos

Execuções de verificação

conjuntos de verificações

Verificações

Códigos de conduta

Verificação de código

Colaboradores

Convites

Confirmações

Comentários de commit

Status do commit

Chaves de implantação

Políticas de branch de implantação

Implantações

Ambientes

Status da implantação

Emojis

Estatísticas de admin

Anúncio

Log de auditoria

Webhooks globais

Licença

Organizações

Ambientes Pre-receive

Usuários

Administração de empresas

Gists

Comentários

Blobs

Referências

Marcações

Árvores

Banco de dados do Git

Gitignore

Problemas

Responsáveis

Rótulos

Marcos

Linha do tempo

Licenças

Markdown

Estatísticas

Métricas

Migrações

Membros

Colaboradores externos

Páginas

Boards

Cartões

Colunas

Project boards

Pulls

Comentários de opiniões

Solicitações de revisão

Análises

Limite de taxa

Reações

Versões

Ativos de versões

Links automáticos

Sumário

Garfos

Git LFS

Repositórios

Search

Teams

Comentários da discussão

Discussões

Grupos externos

Seguidores

Chaves GPG

Chaves SSH do Git

Configuração de webhook do repositório

Entregas do Webhook do Repositório

Webhooks do repositório

API REST

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

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`.

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.

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.

Update a secret scanning alert