Skip to main content
POST
Cancelar um build em andamento

Permissões

Requer um usuário de serviço ou token de acesso pessoal com a permissão ManageOrgSnapshots no nível da organização.

Comportamento

Cancela um build em andamento (status pending ou running) e retorna o build com status cancelled. Somente builds em andamento podem ser cancelados. Se o build já estiver em um estado final (succeeded, failed ou cancelled), a requisição retorna 409 Conflict e o build permanece inalterado.

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

build_id
string
obrigatório
org_id
string
obrigatório

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

Exemplo:

"org-abc123def456"

Resposta

Resposta Bem-Sucedida

Formato do recurso público Build — uma visão opaca de "isso já foi bem-sucedido?".

Conforme a especificação, nenhuma introspecção por plataforma/snapshot/job é exposta. Futuras adições (triggered_by_repo, metadados da build etc.) são aditivas.

build_id
string
obrigatório
completed_at
integer | null
obrigatório
created_at
integer
obrigatório
pinned
boolean
obrigatório
started_at
integer | null
obrigatório
status
enum<string>
obrigatório
Opções disponíveis:
pending,
running,
succeeded,
failed,
cancelled
trigger
enum<string> | null
obrigatório
Opções disponíveis:
manual,
auto
triggered_by_user_id
string | null
obrigatório
updated_at
integer
obrigatório