Skip to main content
PUT
Criar um índice de um repositório

Permissões

Requer um usuário de serviço ou um token de acesso pessoal. A verificação de permissão depende de como o acesso aos repositórios é gerenciado na sua organização:
  • Permissões no nível da organização: quem faz a chamada precisa da permissão IndexOrgRepositories no nível da organização.
  • Concessões granulares por repositório: a permissão IndexOrgRepositories não é verificada. Quem faz a chamada precisa da permissão Read no nível da organização, além das concessões repo.use_read e repo.index no repositório. Caso contrário, a requisição é rejeitada com 403.

Comportamento

Este endpoint é idempotente — chamá-lo várias vezes para o mesmo repositório não cria jobs de indexação duplicados. Ele ativa a indexação e aciona jobs de indexação para o repositório especificado. Opcionalmente, você pode especificar branch_names no corpo da requisição para indexar branches específicas. Se não for especificado, a branch padrão será usada.

Autorizações

Authorization
string
header
obrigatório

Credencial de usuário de serviço (prefixo: cog_)

Parâmetros de caminho

repository_path
string
obrigatório
org_id
string
obrigatório

ID da organização (prefixo: org-)

Exemplo:

"org-abc123def456"

Corpo

application/json
branch_names
string[]

Resposta

Resposta Bem-Sucedida

branches
string[]
obrigatório
indexing_enabled
boolean
obrigatório
repository_path
string
obrigatório
indexing_status
RepoIndexingStatusResponse · object | null