curl --request POST \
--url https://api.devin.ai/v3/organizations/{org_id}/code-scans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"commit_sha": "<string>",
"host": "<string>",
"interactive": false,
"new_budget": {
"acu_limit": 500000
},
"platform": "<string>",
"profile_id": "<string>",
"repo_name": "<string>",
"repos": [
{
"repo_name": "<string>",
"host": "<string>"
}
]
}
'import requests
url = "https://api.devin.ai/v3/organizations/{org_id}/code-scans"
payload = {
"commit_sha": "<string>",
"host": "<string>",
"interactive": False,
"new_budget": { "acu_limit": 500000 },
"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,
new_budget: {acu_limit: 500000},
platform: '<string>',
profile_id: '<string>',
repo_name: '<string>',
repos: [{repo_name: '<string>', host: '<string>'}]
})
};
fetch('https://api.devin.ai/v3/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/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,
'new_budget' => [
'acu_limit' => 500000
],
'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/organizations/{org_id}/code-scans"
payload := strings.NewReader("{\n \"commit_sha\": \"<string>\",\n \"host\": \"<string>\",\n \"interactive\": false,\n \"new_budget\": {\n \"acu_limit\": 500000\n },\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/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 \"new_budget\": {\n \"acu_limit\": 500000\n },\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/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 \"new_budget\": {\n \"acu_limit\": 500000\n },\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>",
"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"
}Iniciar análisis de código (API de Devin)
Inicia un nuevo análisis de código de Devin en uno o más repositorios mediante la API v3 de organizaciones, opcionalmente con un perfil de análisis, un SHA de confirmación o un nivel de esfuerzo
curl --request POST \
--url https://api.devin.ai/v3/organizations/{org_id}/code-scans \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"commit_sha": "<string>",
"host": "<string>",
"interactive": false,
"new_budget": {
"acu_limit": 500000
},
"platform": "<string>",
"profile_id": "<string>",
"repo_name": "<string>",
"repos": [
{
"repo_name": "<string>",
"host": "<string>"
}
]
}
'import requests
url = "https://api.devin.ai/v3/organizations/{org_id}/code-scans"
payload = {
"commit_sha": "<string>",
"host": "<string>",
"interactive": False,
"new_budget": { "acu_limit": 500000 },
"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,
new_budget: {acu_limit: 500000},
platform: '<string>',
profile_id: '<string>',
repo_name: '<string>',
repos: [{repo_name: '<string>', host: '<string>'}]
})
};
fetch('https://api.devin.ai/v3/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/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,
'new_budget' => [
'acu_limit' => 500000
],
'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/organizations/{org_id}/code-scans"
payload := strings.NewReader("{\n \"commit_sha\": \"<string>\",\n \"host\": \"<string>\",\n \"interactive\": false,\n \"new_budget\": {\n \"acu_limit\": 500000\n },\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/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 \"new_budget\": {\n \"acu_limit\": 500000\n },\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/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 \"new_budget\": {\n \"acu_limit\": 500000\n },\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>",
"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"
}Permisos
Requiere un usuario de servicio o un token de acceso personal con el permisoUseCodeScans a nivel de la organización.
Comportamiento
Pone en cola un nuevo análisis de código para el repositorio indicado (repo_name) o los repositorios indicados (repos) en la organización. El análisis se inicia de forma asíncrona mediante el despachador de análisis; la respuesta es el registro del análisis con un status inicial de waiting o pending. Consulte periódicamente List Code Scans para seguir el progreso y List Code Scan Findings (filtrado por scan_id) para consultar los resultados cuando el análisis alcance completed.
El análisis se atribuye al principal que realiza la llamada (el usuario de servicio o PAT que realizó la solicitud). El equivalente de ámbito Enterprise es Iniciar análisis de código (Enterprise).
Campos de la solicitud
Indica solo uno de los campos:repo_name o repos.
repo_name: nombre completo del repositorio, p. ej.,owner/repo. El repositorio ya debe ser accesible mediante la integración de Git de la organización.host: host de Git del repositorio, si no se puede inferir.repos: repositorios que abarca un único análisis multirrepositorio, como una lista de objetos conrepo_namey unhostopcional (hasta 200). La primera entrada es el repositorio principal del análisis.profile_id: un perfil de análisis que se aplicará. Usa Iniciar análisis de ingesta para perfiles en modoingest.scan_type: tipo de análisis que se ejecutará. Debe coincidir con el tipo de análisis del perfil si se proporcionaprofile_id. De forma predeterminada, usa el tipo del perfil osecuritypara análisis sin perfil. Los tipos de análisis que no son de seguridad requieren un perfil.commit_sha: confirmación que se debe extraer antes del análisis. De forma predeterminada, usa la última confirmación de la rama predeterminada del repositorio.effort:normal(predeterminado) usa un menor esfuerzo de razonamiento del modelo con lotes de investigación más grandes;deepejecuta el proceso completo.interactive: cuando estrue, el análisis se pausa enawaiting_user_inputpara que el usuario lo revise entre el modelado de amenazas y la investigación. El valor predeterminado esfalse. Solo los análisis de seguridad admiten la revisión interactiva; los demás tipos de análisis se ejecutan sin supervisión.platform: dónde se ejecutan las sesiones del análisis: una etiqueta de plataforma configurada para la organización (por ejemplo,linux,windowsomacos) o el nombre de un pool de outposts, sin distinguir mayúsculas de minúsculas. Las plataformas tienen prioridad cuando un nombre coincide con ambas. De forma predeterminada, usa el valor predeterminado de la organización.
Errores
400siscan_typeentra en conflicto con el perfil, si se proporciona unscan_typeque no es de seguridad sin un perfil o siplatformno coincide con ninguna etiqueta de plataforma configurada ni con ningún pool de outposts (el cuerpo del error enumera los valores disponibles).403si la organización está restringida a análisis de solo ingesta y no se proporciona un perfil en modoingest.404si el repositorio o el perfil no son visibles para la organización.409si el backlog de análisis de la organización está lleno. Vuelve a intentarlo más tarde.422si se proporcionan tantorepo_namecomoreposo ninguno de los dos, o sireposestá vacío.
Autorizaciones
Credencial de usuario de servicio (prefijo: cog_)
Parámetros de ruta
ID de la organización (prefijo: org-)
"org-abc123def456"
Cuerpo
Cuerpo de la solicitud para iniciar un nuevo análisis de código.
Confirmación de código que se debe seleccionar mediante checkout antes del análisis.
Nivel de esfuerzo del análisis: 'normal' (predeterminado) utiliza un menor esfuerzo de razonamiento del modelo y lotes de investigación más grandes; 'deep' ejecuta el proceso completo.
normal, deep Servidor Git del repositorio, si se conoce.
Si el valor es true, el análisis se pausa entre el modelado de amenazas y la investigación para que el usuario lo revise.
Asigna al análisis su propio presupuesto de ACU. Requiere los permisos ManageAccountServiceUsers y ManageAcuLimits.
Show child attributes
Show child attributes
Dónde se ejecutan las sesiones del análisis: una etiqueta de plataforma configurada para la organización (p. ej., 'linux', 'windows', 'macos') o el nombre de un pool de outposts (BYOB), sin distinguir entre mayúsculas y minúsculas; las plataformas tienen prioridad si un nombre coincide tanto con una plataforma como con un pool. Si se omite, se usa el valor predeterminado de la organización. Los valores no reconocidos se rechazan con un error 400 cuyo cuerpo enumera las etiquetas de plataforma y los nombres de pools de outposts disponibles.
128Perfil de análisis que se aplicará al análisis.
Nombre completo del repositorio que se analizará. Proporciona solo uno de los campos repo_name o repos.
Repositorios que abarca un análisis; la primera entrada es el repositorio principal del análisis. Proporciona solo uno de los campos repo_name o repos.
200Show child attributes
Show child attributes
Tipo de análisis que se ejecutará. Si se proporciona un perfil, debe coincidir con su tipo de análisis. El valor predeterminado es el tipo del perfil, o 'security' si no hay perfil. Los tipos distintos de 'security' requieren un perfil y se rechazan si no se proporciona uno.
security, performance, db-queries, test-coverage, dead-code, code-quality, cleanup, telemetry, accessibility, compliance, general, migration-docs Respuesta
Respuesta exitosa
Un análisis de código individual.
Momento en que se creó el análisis (segundos Unix).
Nivel de esfuerzo del análisis: 'normal' utiliza un nivel de esfuerzo de razonamiento del modelo más bajo y lotes de investigación más grandes; 'deep' ejecuta el proceso completo.
normal, deep Host de Git del repositorio, si se conoce.
Organización a la que pertenece el análisis.
Perfil con el que se ejecutó el análisis, si corresponde.
Show child attributes
Show child attributes
Repositorio principal del análisis. Los análisis de varios repositorios abarcan repositorios adicionales que no se enumeran aquí.
Identificador único del análisis.
Tipo de análisis, establecido al crearlo.
security, performance, db-queries, test-coverage, dead-code, code-quality, cleanup, telemetry, accessibility, compliance, general, migration-docs Estado del análisis: waiting, pending, running, awaiting_user_input, completed, failed o cancelled.
waiting, pending, running, awaiting_user_input, completed, failed, cancelled URL de la página del análisis en la webapp de Devin.
Pool de outposts en el que se ejecutan las sesiones del análisis, si se ha configurado uno.
Etiqueta de la plataforma alojada en la que se ejecutan las sesiones del análisis. Null cuando el análisis se ejecuta en un pool de outposts o con la configuración predeterminada de la organización.
Identidad del repositorio principal que incluye el host (p. ej., github.com/org/repo). Null para los depósitos de Perforce, que no tienen un host de Git.

