Iniciar varredura de código (API do Devin)

Iniciar varredura de código

curl --request POST \
  --url https://api.devin.ai/v3/enterprise/organizations/{org_id}/code-scans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "commit_sha": "<string>",
  "host": "<string>",
  "interactive": false,
  "locale": "<string>",
  "platform": "<string>",
  "profile_id": "<string>",
  "repo_name": "<string>",
  "repos": [
    {
      "repo_name": "<string>",
      "host": "<string>"
    }
  ]
}
'

import requests

url = "https://api.devin.ai/v3/enterprise/organizations/{org_id}/code-scans"

payload = {
    "commit_sha": "<string>",
    "host": "<string>",
    "interactive": False,
    "locale": "<string>",
    "platform": "<string>",
    "profile_id": "<string>",
    "repo_name": "<string>",
    "repos": [
        {
            "repo_name": "<string>",
            "host": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    commit_sha: '<string>',
    host: '<string>',
    interactive: false,
    locale: '<string>',
    platform: '<string>',
    profile_id: '<string>',
    repo_name: '<string>',
    repos: [{repo_name: '<string>', host: '<string>'}]
  })
};

fetch('https://api.devin.ai/v3/enterprise/organizations/{org_id}/code-scans', 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/v3/enterprise/organizations/{org_id}/code-scans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'commit_sha' => '<string>',
    'host' => '<string>',
    'interactive' => false,
    'locale' => '<string>',
    'platform' => '<string>',
    'profile_id' => '<string>',
    'repo_name' => '<string>',
    'repos' => [
        [
                'repo_name' => '<string>',
                'host' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.devin.ai/v3/enterprise/organizations/{org_id}/code-scans"

	payload := strings.NewReader("{\n  \"commit_sha\": \"<string>\",\n  \"host\": \"<string>\",\n  \"interactive\": false,\n  \"locale\": \"<string>\",\n  \"platform\": \"<string>\",\n  \"profile_id\": \"<string>\",\n  \"repo_name\": \"<string>\",\n  \"repos\": [\n    {\n      \"repo_name\": \"<string>\",\n      \"host\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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/v3/enterprise/organizations/{org_id}/code-scans")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"commit_sha\": \"<string>\",\n  \"host\": \"<string>\",\n  \"interactive\": false,\n  \"locale\": \"<string>\",\n  \"platform\": \"<string>\",\n  \"profile_id\": \"<string>\",\n  \"repo_name\": \"<string>\",\n  \"repos\": [\n    {\n      \"repo_name\": \"<string>\",\n      \"host\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.devin.ai/v3/enterprise/organizations/{org_id}/code-scans")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"commit_sha\": \"<string>\",\n  \"host\": \"<string>\",\n  \"interactive\": false,\n  \"locale\": \"<string>\",\n  \"platform\": \"<string>\",\n  \"profile_id\": \"<string>\",\n  \"repo_name\": \"<string>\",\n  \"repos\": [\n    {\n      \"repo_name\": \"<string>\",\n      \"host\": \"<string>\"\n    }\n  ]\n}"

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

{
  "created_at": 123,
  "effort": "normal",
  "host": "<string>",
  "org_id": "<string>",
  "profile": {
    "name": "<string>",
    "profile_id": "<string>"
  },
  "repo_name": "<string>",
  "scan_id": "<string>",
  "scan_type": "security",
  "status": "waiting",
  "url": "<string>",
  "attachments": [
    {
      "filename": "<string>",
      "url": "<string>"
    }
  ],
  "outpost_pool_id": "<string>",
  "platform": "<string>",
  "repo_full_name": "<string>"
}

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

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

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

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

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

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

POST

enterprise

organizations

{org_id}

code-scans

Iniciar varredura de código

curl --request POST \
  --url https://api.devin.ai/v3/enterprise/organizations/{org_id}/code-scans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "commit_sha": "<string>",
  "host": "<string>",
  "interactive": false,
  "locale": "<string>",
  "platform": "<string>",
  "profile_id": "<string>",
  "repo_name": "<string>",
  "repos": [
    {
      "repo_name": "<string>",
      "host": "<string>"
    }
  ]
}
'

import requests

url = "https://api.devin.ai/v3/enterprise/organizations/{org_id}/code-scans"

payload = {
    "commit_sha": "<string>",
    "host": "<string>",
    "interactive": False,
    "locale": "<string>",
    "platform": "<string>",
    "profile_id": "<string>",
    "repo_name": "<string>",
    "repos": [
        {
            "repo_name": "<string>",
            "host": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    commit_sha: '<string>',
    host: '<string>',
    interactive: false,
    locale: '<string>',
    platform: '<string>',
    profile_id: '<string>',
    repo_name: '<string>',
    repos: [{repo_name: '<string>', host: '<string>'}]
  })
};

fetch('https://api.devin.ai/v3/enterprise/organizations/{org_id}/code-scans', 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/v3/enterprise/organizations/{org_id}/code-scans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'commit_sha' => '<string>',
    'host' => '<string>',
    'interactive' => false,
    'locale' => '<string>',
    'platform' => '<string>',
    'profile_id' => '<string>',
    'repo_name' => '<string>',
    'repos' => [
        [
                'repo_name' => '<string>',
                'host' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.devin.ai/v3/enterprise/organizations/{org_id}/code-scans"

	payload := strings.NewReader("{\n  \"commit_sha\": \"<string>\",\n  \"host\": \"<string>\",\n  \"interactive\": false,\n  \"locale\": \"<string>\",\n  \"platform\": \"<string>\",\n  \"profile_id\": \"<string>\",\n  \"repo_name\": \"<string>\",\n  \"repos\": [\n    {\n      \"repo_name\": \"<string>\",\n      \"host\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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/v3/enterprise/organizations/{org_id}/code-scans")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"commit_sha\": \"<string>\",\n  \"host\": \"<string>\",\n  \"interactive\": false,\n  \"locale\": \"<string>\",\n  \"platform\": \"<string>\",\n  \"profile_id\": \"<string>\",\n  \"repo_name\": \"<string>\",\n  \"repos\": [\n    {\n      \"repo_name\": \"<string>\",\n      \"host\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.devin.ai/v3/enterprise/organizations/{org_id}/code-scans")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"commit_sha\": \"<string>\",\n  \"host\": \"<string>\",\n  \"interactive\": false,\n  \"locale\": \"<string>\",\n  \"platform\": \"<string>\",\n  \"profile_id\": \"<string>\",\n  \"repo_name\": \"<string>\",\n  \"repos\": [\n    {\n      \"repo_name\": \"<string>\",\n      \"host\": \"<string>\"\n    }\n  ]\n}"

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

{
  "created_at": 123,
  "effort": "normal",
  "host": "<string>",
  "org_id": "<string>",
  "profile": {
    "name": "<string>",
    "profile_id": "<string>"
  },
  "repo_name": "<string>",
  "scan_id": "<string>",
  "scan_type": "security",
  "status": "waiting",
  "url": "<string>",
  "attachments": [
    {
      "filename": "<string>",
      "url": "<string>"
    }
  ],
  "outpost_pool_id": "<string>",
  "platform": "<string>",
  "repo_full_name": "<string>"
}

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

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

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

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

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

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

Permissões

É necessário ter um usuário de serviço ou um token de acesso pessoal com a permissão UseAccountCodeScans no nível Enterprise.

Comportamento

Enfileira uma nova varredura de código para o repositório (repo_name) ou os repositórios (repos) especificados na organização informada. A varredura é iniciada de forma assíncrona pelo despachante de varreduras; a resposta é o registro da varredura com status inicial waiting ou pending. Consulte Listar varreduras de código para acompanhar o progresso e Listar resultados de varreduras de código (filtrados por scan_id) para ver os resultados quando a varredura atingir completed. A varredura é atribuída ao principal que fez a chamada (o usuário de serviço ou PAT que fez a requisição).

Campos da requisição

Forneça exatamente um entre repo_name e repos.

repo_name: nome completo do repositório, por exemplo, owner/repo. O repositório já deve estar acessível por meio da integração Git da organização.
host: host Git do repositório, caso não possa ser inferido.
repos: repositórios abrangidos por uma única varredura multirrepositório, como uma lista de objetos com repo_name e um host opcional (até 200). A primeira entrada é o repositório principal da varredura.
profile_id: um perfil de varredura a ser aplicado. Use Iniciar varredura de ingestão para perfis no modo ingest.
scan_type: tipo de varredura a executar. Deve corresponder ao tipo de varredura do perfil quando profile_id for informado. Por padrão, usa o tipo do perfil ou security para varreduras sem perfil. Tipos de varredura que não são de Security exigem um perfil.
commit_sha: commit a ser usado no checkout antes da varredura. Por padrão, usa o head da branch padrão do repositório.
effort: normal (padrão) usa menos esforço de raciocínio do modelo, com lotes de investigação maiores; deep executa o pipeline completo.
interactive: quando true, a varredura é pausada em awaiting_user_input para revisão do usuário entre a modelagem de ameaças e a investigação. O padrão é false. Apenas varreduras de Security oferecem suporte à revisão interativa; os demais tipos de varredura são executados sem supervisão.
platform: onde as sessões da varredura são executadas: um rótulo de plataforma configurado para a organização (por exemplo, linux, windows ou macos) ou o nome de um pool do outpost, sem diferenciar maiúsculas de minúsculas. Se um nome corresponder a ambos, a plataforma tem prioridade. Por padrão, usa o valor padrão da organização.

Erros

400 quando scan_type é incompatível com o perfil, quando um scan_type que não é de Security é informado sem perfil ou quando platform não corresponde a um rótulo de plataforma configurado nem a um pool do outpost (o corpo do erro lista os valores disponíveis).
403 quando a organização está restrita a varreduras somente de ingestão e nenhum perfil no modo ingest é informado.
404 quando a organização, o repositório ou o perfil não está visível para a conta Enterprise.
409 quando o backlog de varreduras da organização atingiu a capacidade máxima. Tente novamente mais tarde.
422 quando repo_name e repos são informados ao mesmo tempo, quando nenhum dos dois é informado ou quando repos está vazio.

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

org_id

string

obrigatório

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

Exemplo:

"org-abc123def456"

Corpo

application/json

Corpo da requisição para iniciar uma nova varredura de código.

commit_sha

string | null

Commit para fazer checkout antes da varredura.

devin_mode

enum<string> | null

Agente no qual as sessões da varredura são executadas: 'fusion' ou 'swe-2' (SWE-2 Max para o esforço 'deep', SWE-2 High para 'normal'). Aplica-se apenas quando o modo está ativado para a organização; caso contrário, ou quando omitido, a varredura é executada no agente padrão.

Opções disponíveis:

fusion,

swe-2

effort

enum<string> | null

Esforço da varredura: 'normal' (padrão) usa um nível menor de esforço de raciocínio do modelo, com lotes maiores de investigação; 'deep' executa o pipeline completo.

Opções disponíveis:

normal,

deep

host

string | null

Host Git do repositório, se conhecido.

interactive

boolean

padrão:false

Quando true, a varredura é pausada para revisão pelo usuário entre a modelagem de ameaças e a investigação.

locale

string | null

Tag de idioma BCP-47 (p. ex. 'ja') para a saída da varredura voltada ao usuário: títulos de resultados, descrições e relatórios. Quando omitida, o idioma é inglês.

platform

string | null

Onde as sessões da varredura são executadas: um rótulo de plataforma configurado para a organização (por exemplo, 'linux', 'windows', 'macos') ou o nome de um pool do outpost (BYOB), sem distinção entre maiúsculas e minúsculas; as plataformas têm prioridade quando um nome corresponde a ambos. Se omitido, usa o padrão da organização. Valores não reconhecidos são rejeitados com uma resposta 400 cujo corpo de erro lista os rótulos de plataforma e os nomes de pools do outpost disponíveis.

Maximum string length: 128

profile_id

string | null

Perfil de varredura a ser aplicado à varredura.

repo_name

string | null

Nome completo do repositório a ser varrido. Forneça exatamente um dos campos: repo_name ou repos.

repos

ScanRepoRequest · object[] | null

Repositórios abrangidos por uma varredura; o primeiro item é o repositório principal da varredura. Forneça exatamente um dos campos: repo_name ou repos.

Maximum array length: 200

Show child attributes

scan_type

enum<string> | null

Tipo de varredura a executar. Deve corresponder ao tipo de varredura do perfil quando um perfil é fornecido; por padrão, usa o tipo do perfil ou 'security' para varreduras sem perfil. Tipos que não são de segurança exigem um perfil e são rejeitados sem um.

Opções disponíveis:

security,

performance,

db-queries,

test-coverage,

dead-code,

code-quality,

cleanup,

telemetry,

accessibility,

compliance,

general,

migration-docs

Resposta

Resposta bem-sucedida

Uma única varredura de código.

created_at

integer

obrigatório

Quando a varredura foi criada (segundos Unix).

effort

enum<string>

obrigatório

Esforço da varredura: 'normal' usa um nível menor de esforço de raciocínio do modelo e lotes maiores de investigação; 'deep' executa o pipeline completo.

Opções disponíveis:

normal,

deep

host

string | null

obrigatório

Host Git do repositório, se conhecido.

org_id

string

obrigatório

Organização à qual a varredura pertence.

profile

CodeScanProfileResponse · object | null

obrigatório

Perfil sob o qual a varredura foi executada, se houver.

Show child attributes

repo_name

string

obrigatório

Repositório principal da varredura. Varreduras com vários repositórios abrangem repositórios adicionais não listados aqui.

scan_id

string

obrigatório

Identificador único da varredura.

scan_type

enum<string>

obrigatório

Tipo de varredura, definido na criação.

Opções disponíveis:

security,

performance,

db-queries,

test-coverage,

dead-code,

code-quality,

cleanup,

telemetry,

accessibility,

compliance,

general,

migration-docs

status

enum<string>

obrigatório

Status da varredura: waiting, pending, running, awaiting_user_input, completed, failed ou cancelled.

Opções disponíveis:

waiting,

pending,

running,

awaiting_user_input,

completed,

failed,

cancelled

url

string

obrigatório

URL da página da varredura no webapp do Devin.

attachments

CodeScanAttachmentResponse · object[]

Arquivos anexados à varredura no momento da criação.

Show child attributes

outpost_pool_id

string | null

Pool do outpost em que as sessões da varredura são executadas, se definido.

platform

string | null

Rótulo da plataforma hospedada em que as sessões da varredura são executadas. Null quando a varredura é executada em um pool do outpost ou usa o padrão da organização.

repo_full_name

string | null

Identidade do repositório principal qualificada pelo host (por exemplo, github.com/org/repo). Null para depósitos Perforce, que não têm servidor Git.

Primeiros passos

Conceitos

Ciclo de vida do agente

Gerenciamento de contexto

Gerenciamento de ambiente

Automação

Integrações

Análises

Observabilidade

Devin para Security

Infraestrutura

Identidade e acesso

Configuração

API legada v1

API legada v2

Iniciar varredura de código (API do Devin)

Permissões

Comportamento

Campos da requisição

Erros

Autorizações

Parâmetros de caminho

Corpo

Resposta