Cancelar uma build em andamento

POST /v3beta1/organizations/{org_id}/snapshot-setup/builds/{build_id}/cancel

Cancelar uma build em andamento

cURL

curl --request POST \
  --url https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/builds/{build_id}/cancel \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/builds/{build_id}/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/builds/{build_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/builds/{build_id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/builds/{build_id}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/builds/{build_id}/cancel")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.devin.ai/v3beta1/organizations/{org_id}/snapshot-setup/builds/{build_id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "build_id": "<string>",
  "completed_at": 123,
  "created_at": 123,
  "pinned": true,
  "started_at": 123,
  "triggered_by_user_id": "<string>",
  "updated_at": 123
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

{
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "errors": [
    {}
  ],
  "instance": "<string>",
  "type": "about:blank"
}

​

Permissões

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

​

Comportamento

Cancela um build em andamento. Não afeta builds que já foram concluídos.

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

200

application/json

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