This page is not yet available in English. Read it in Portuguese

Skip to content
Menu da documentação

API v1 (engenharia)

Referência das rotas v1

Todas as rotas da API v1 por chave, agrupadas por produto, com método, caminho, escopo exigido, para que servem e o comando da CLI.

Base https://aiuby.com/api/v1. Parâmetros, corpos e respostas completos estão em /api/v1/openapi.json; envelope, limites e erros, em API v1. Cada página de produto traz exemplos com curl.

#Grafo de engenharia

RotaEscopoPara quêCLI
GET /api/v1/engineering/catalogLer a engenharia (API v1) engineering:readLista o catálogo de engenhariaaiuby graph services
GET /api/v1/engineering/entities/{id}Ler a engenharia (API v1) engineering:readEntidade e vizinhançaaiuby graph entity <id>
GET /api/v1/engineering/eventsLer a engenharia (API v1) engineering:readEventos recentesaiuby graph events
POST /api/v1/engineering/queryLer a engenharia (API v1) engineering:readConsulta estruturada ao grafoaiuby graph ask

#Engineering Intelligence

Exemplos e o que ainda não existe: Engineering Intelligence.

RotaEscopoPara quêCLI
GET /api/v1/engineering/insights/deliveryLer a engenharia (API v1) engineering:readIndicadores de entregaaiuby insights delivery
GET /api/v1/engineering/doraLer a engenharia (API v1) engineering:readIndicadores DORAaiuby dora
GET /api/v1/engineering/ai-efficiencyLer a engenharia (API v1) engineering:readAdoção e gasto de ferramentas de IAaiuby ai-efficiency
GET /api/v1/engineering/intelLer a engenharia (API v1) engineering:readInteligência de engenharia por timeaiuby intel
POST /api/v1/engineering/work-itemsEnviar itens de trabalho (tickets) engineering:ingestEnviar itens de trabalho (tickets)aiuby work-items push
GET /api/v1/code-review/reviewsLer a engenharia (API v1) engineering:readRevisões de PR por IAaiuby code-review list
GET /api/v1/code-review/reviews/{id}Ler a engenharia (API v1) engineering:readUma revisão de PRaiuby code-review get <id>
GET /api/v1/code-review/checkLer a engenharia (API v1) engineering:readPortão de revisão de um PR (para o CI)aiuby code-review check
GET /api/v1/code-review/branch-policyLer a engenharia (API v1) engineering:readPolítica de branch conferida no GitHubaiuby code-review branch-policy
GET /api/v1/code-review/metricsLer a engenharia (API v1) engineering:readMétricas da revisão por IAaiuby code-review metrics

#Incident Management

Exemplos e o que ainda não existe: Incident Management.

RotaEscopoPara quêCLI
GET /api/v1/engineering/slosLer a engenharia (API v1) engineering:readLista os SLOsaiuby slos list
GET /api/v1/engineering/slos/{id}Ler a engenharia (API v1) engineering:readEstado de um SLOaiuby slos get <id>
GET /api/v1/engineering/slo-compositesLer a engenharia (API v1) engineering:readLista os SLOs compostosaiuby slos composites
GET /api/v1/engineering/slo-composites/{id}Ler a engenharia (API v1) engineering:readEstado de um SLO compostoaiuby slos composite <id>
GET /api/v1/engineering/incidentsLer a engenharia (API v1) engineering:readIncidentesaiuby incidents list
GET /api/v1/engineering/incidents/{id}Ler a engenharia (API v1) engineering:readUm incidenteaiuby incidents get <id>
GET /api/v1/engineering/runbooksLer a engenharia (API v1) engineering:readRunbooksaiuby runbooks list
GET /api/v1/engineering/runbooks/{id}Ler a engenharia (API v1) engineering:readUm runbookaiuby runbooks get <id>

#Security Testing

Exemplos e o que ainda não existe: Security Testing.

Liberam estas rotas: Guard ou Cortex ativo na organização (basta um).

RotaEscopoPara quêCLI
POST /api/v1/engineering/security/sarifEnviar SARIF e SBOM do CI security:writeEnvia resultado SARIF 2.1.0aiuby security upload-sarif
POST /api/v1/engineering/security/sbomEnviar SARIF e SBOM do CI security:writeEnvia SBOM externoaiuby security upload-sbom
GET /api/v1/engineering/security/findingsLer a engenharia (API v1) engineering:readAchados dos scannersaiuby security findings
GET /api/v1/engineering/security/gateLer a engenharia (API v1) engineering:read (ou security:read)Portão de severidade do repositório (CI)aiuby security gate
GET /api/v1/engineering/security/scansLer a engenharia (API v1) engineering:readScans de segurançaaiuby security scans
POST /api/v1/engineering/security/scansPedir scan de segurança (agente de código) security:scanPede um scan pelo CIaiuby security scan
GET /api/v1/engineering/security/scans/{id}Ler a engenharia (API v1) engineering:readUm scan e os achados deleaiuby security scans get <id>
GET /api/v1/engineering/sbomLer a engenharia (API v1) engineering:readSBOMs dos scansaiuby sbom get
GET /api/v1/engineering/sbom/whereLer a engenharia (API v1) engineering:readOnde usamos um pacote ou vulnerabilidadeaiuby sbom where
GET /api/v1/engineering/sbom/{id}Ler a engenharia (API v1) engineering:readUm SBOM e os componentesaiuby sbom get
GET /api/v1/engineering/sbom/{id}/exportLer a engenharia (API v1) engineering:readExportar SBOM (CycloneDX ou SPDX)aiuby sbom get --format

#Test Automation

Exemplos e o que ainda não existe: Test Automation.

RotaEscopoPara quêCLI
GET /api/v1/engineering/test-plansLer a engenharia (API v1) engineering:readPlanos de teste declarativosaiuby test-plans list
POST /api/v1/tests/runsRodar suítes Playwright no CI tests:runDisparar a suíte Playwright do repositório (portão do CI)aiuby tests run
GET /api/v1/tests/runs/{id}Rodar suítes Playwright no CI tests:runEstado de uma execução de suíteaiuby tests status <id>

#Software Delivery

Exemplos e o que ainda não existe: Software Delivery.

RotaEscopoPara quêCLI
GET /api/v1/engineering/artifacts/repositoriesLer a engenharia (API v1) engineering:readRepositórios de artefatosaiuby artifacts list
GET /api/v1/engineering/artifactsLer a engenharia (API v1) engineering:readArtefatosaiuby artifacts list
GET /api/v1/engineering/artifacts/versionsLer a engenharia (API v1) engineering:readVersões e tagsaiuby artifacts tags
GET /api/v1/engineering/artifacts/versions/{id}Ler a engenharia (API v1) engineering:readUma versão—
POST /api/v1/engineering/artifacts/credentialsImplantar no Compute (CLI) compute:deployCredencial de push/pullaiuby artifacts login
POST /api/v1/iac/checkCheck de IaC no CI iac:checkCheck de IaC de um PR (portão do CI)aiuby iac check
GET /api/v1/iac/check/{id}Check de IaC no CI iac:checkEstado de um check de IaCaiuby iac check --wait
POST /api/v1/iac/appliedCheck de IaC no CI iac:checkRegistrar o apply feito pelo CIaiuby iac applied
POST /api/v1/db/checkCheck de migrações no CI db:checkCheck de migrações SQL de um PR (portão do CI)aiuby db check
GET /api/v1/db/check/{id}Check de migrações no CI db:checkEstado de um check de migraçõesaiuby db check --wait
POST /api/v1/iac/runsRodar plan e apply gerenciados de IaC iac:runDisparar um plan gerenciado de IaCaiuby iac plan
GET /api/v1/iac/runsRodar plan e apply gerenciados de IaC iac:runExecuções de IaCaiuby iac runs
GET /api/v1/iac/runs/{id}Rodar plan e apply gerenciados de IaC iac:runEstado de uma execução de IaCaiuby iac run <id>
POST /api/v1/iac/runs/{id}/applyRodar plan e apply gerenciados de IaC iac:runAplicar um plan aprovadoaiuby iac apply <id>
GET /api/v1/iac/runs/{id}/insightRodar plan e apply gerenciados de IaC iac:runCusto estimado e raio de impacto de um planaiuby iac insight <id>
GET /api/v1/iac/runs/reportRodar plan e apply gerenciados de IaC iac:runRelatório do histórico de IaC por workspaceaiuby iac report
GET /api/v1/db/databasesLer o histórico de bancos e migrações db:readBancos cadastradosaiuby db databases
GET /api/v1/db/migrationsLer o histórico de bancos e migrações db:readHistórico de migrações de um bancoaiuby db migrations <banco>
POST /api/v1/db/migrationsRelatar migrações de banco no CI db:reportRelatar uma migração aplicada, desfeita ou que falhouaiuby db report
POST /api/v1/db/migrations/gateRelatar migrações de banco no CI db:reportPortão antes de aplicar migraçõesaiuby db gate
POST /api/v1/db/schema-snapshotsRelatar migrações de banco no CI db:reportEnviar o retrato do schema de um bancoaiuby db snapshot
GET /api/v1/db/schema-diffLer o histórico de bancos e migrações db:readDiferença de schema entre dois bancosaiuby db schema-diff
GET /api/v1/delivery/releasesLer a engenharia (API v1) engineering:read (ou delivery:approve, delivery:rollback)Releases de entrega em Kubernetesaiuby releases list
GET /api/v1/delivery/releases/{id}Ler a engenharia (API v1) engineering:read (ou delivery:approve, delivery:rollback)Estado de uma releaseaiuby releases get <id>
POST /api/v1/delivery/releases/{id}/approveAprovar estágios de release (CLI) delivery:approveAprovar o estágio que espera aprovaçãoaiuby releases approve <id>
POST /api/v1/delivery/releases/{id}/rollbackVoltar releases (CLI) delivery:rollbackVoltar uma releaseaiuby releases rollback <id>
POST /api/v1/delivery/agent/syncdelivery:agentAgente de entrega: relatar e buscar o estado desejado—
POST /api/v1/deploy/vm-agent/syncdelivery:agentAgente da VM: relatar e buscar a imagem a rodar—
GET /api/v1/pipelinesLer a engenharia (API v1) engineering:readPipelines de CIaiuby pipelines list
GET /api/v1/pipelines/templatesLer a engenharia (API v1) engineering:readModelos de pipelineaiuby pipelines templates
GET /api/v1/pipelines/{id}/variablesLer a engenharia (API v1) engineering:readVariáveis e segredos de um pipeline (só nomes)aiuby pipelines variables <id>
GET /api/v1/pipelines/{id}/runsLer a engenharia (API v1) engineering:readExecuções de um pipelineaiuby pipelines runs <id>
GET /api/v1/pipelines/runs/{id}Ler a engenharia (API v1) engineering:readUma execução de pipelineaiuby pipelines run <id>
POST /api/v1/pipelines/runs/{id}/approvalAprovar estágios de release (CLI) delivery:approveAprovar ou recusar o portão de uma execução (só portão com allowApiKey)—

#Feature Management

Exemplos e o que ainda não existe: Feature Management.

RotaEscopoPara quêCLI
GET /api/v1/engineering/flagsLer a engenharia (API v1) engineering:readFeature flagsaiuby flags list
GET /api/v1/engineering/flag-cleanupLer a engenharia (API v1) engineering:readFlags candidatas a limpezaaiuby flags cleanup

#AI Engineering

Exemplos e o que ainda não existe: AI Engineering.

RotaEscopoPara quêCLI
GET /api/v1/skillsBaixar skills publicadas skills:readSkills publicadasaiuby skills list
GET /api/v1/skills/{name}Baixar skills publicadas skills:readBaixar uma skillaiuby skills get <nome>
GET /api/v1/agents/{id}/eval-casesAvaliações de agentes (SDK e MCP) agents:evalCasos da suíte de avaliação de um agenteaiuby evals cases <agente>
POST /api/v1/agents/{id}/eval-casesAvaliações de agentes (SDK e MCP) agents:evalCriar caso de avaliaçãoaiuby evals add-case <agente>
GET /api/v1/agents/{id}/evaluationsAvaliações de agentes (SDK e MCP) agents:evalÚltima avaliação do agenteaiuby evals latest <agente>
POST /api/v1/agents/{id}/evaluationsAvaliações de agentes (SDK e MCP) agents:evalRodar a suíte de avaliaçãoaiuby evals run <agente>
GET /api/v1/evaluations/{id}Avaliações de agentes (SDK e MCP) agents:evalResultado de uma avaliaçãoaiuby evals get <id>
POST /api/v1/otel/v1/tracesTraces de agentes externos (OpenTelemetry) agents:traceIngestão OpenTelemetry (OTLP/HTTP JSON)—

#AI & API Security

Exemplos e o que ainda não existe: AI & API Security.

Liberam estas rotas: Guard ou Cortex ativo na organização (basta um).

RotaEscopoPara quêCLI
POST /api/v1/api-security/trafficEnviar tráfego de APIs (log do gateway) api-security:ingestEnviar tráfego observado (log do gateway ou espelhamento)aiuby apis traffic
GET /api/v1/api-security/applicationsLer a engenharia (API v1) engineering:readAplicações do inventário de APIsaiuby apis applications
GET /api/v1/api-security/policiesLer a engenharia (API v1) engineering:readPolíticas configuráveis de posturaaiuby apis policies
GET /api/v1/api-security/apis/{id}/specLer a engenharia (API v1) engineering:readOpenAPI gerado do inventárioaiuby apis spec <id>
GET /api/v1/api-security/apisLer a engenharia (API v1) engineering:readInventário de APIsaiuby apis list
GET /api/v1/api-security/apis/{id}Ler a engenharia (API v1) engineering:readUma API do inventárioaiuby apis get <id>
GET /api/v1/api-security/apis/{id}/driftLer a engenharia (API v1) engineering:readDrift da especificaçãoaiuby apis drift <id>
GET /api/v1/api-security/findingsLer a engenharia (API v1) engineering:readAchados de postura de APIaiuby apis findings
GET /api/v1/api-protection/protectionsLer a engenharia (API v1) engineering:readProteções de APIaiuby api-protection list
GET /api/v1/api-protection/protections/{id}Ler a engenharia (API v1) engineering:readUma proteção de APIaiuby api-protection get <id>
GET /api/v1/api-protection/protections/{id}/statsLer a engenharia (API v1) engineering:readEstatísticas de uma proteçãoaiuby api-protection stats <id>
GET /api/v1/api-protection/protections/{id}/samplesLer a engenharia (API v1) engineering:readAmostras redigidas de uma proteçãoaiuby api-protection samples <id>

#Resilience Testing

Exemplos e o que ainda não existe: Resilience Testing.

RotaEscopoPara quêCLI
GET /api/v1/load-tests/scenariosTeste de carga (pipeline e Terraform) load-test:runCenários de carga do workspaceaiuby load-tests scenarios list
POST /api/v1/load-tests/scenariosTeste de carga (pipeline e Terraform) load-test:runCriar cenário de carga (carga como código)aiuby load-tests scenarios create
GET /api/v1/load-tests/scenarios/{id}Teste de carga (pipeline e Terraform) load-test:runUm cenário de cargaaiuby load-tests scenarios get <id>
DELETE /api/v1/load-tests/scenarios/{id}Teste de carga (pipeline e Terraform) load-test:runRemover cenário de cargaaiuby load-tests scenarios delete <id>
POST /api/v1/load-tests/runsTeste de carga (pipeline e Terraform) load-test:runDisparar teste de carga (etapa do pipeline)aiuby load-tests run
GET /api/v1/load-tests/runs/{id}Teste de carga (pipeline e Terraform) load-test:runEstado e veredito do teste de cargaaiuby load-tests status <id>
POST /api/v1/resilience/checkCheck de resiliência no CI resilience:checkCheck de resiliência de um PR (portão do CI)aiuby resilience check

#Code Automation

Exemplos e o que ainda não existe: Code Automation.

RotaEscopoPara quêCLI
GET /api/v1/code-automation/ticketsLer a engenharia (API v1) engineering:readTickets do Code Automationaiuby tickets list
GET /api/v1/code/searchLer a engenharia (API v1) engineering:readBusca de códigoaiuby code search

#Developer Portal

Exemplos e o que ainda não existe: Developer Portal.

RotaEscopoPara quêCLI
GET /api/v1/engineering/portal/servicesLer a engenharia (API v1) engineering:readCatálogo do Developer Portalaiuby catalog list
GET /api/v1/engineering/portal/services/{id}Ler a engenharia (API v1) engineering:readServiço e notas dos scorecardsaiuby catalog get <id>
GET /api/v1/engineering/portal/scorecardsLer a engenharia (API v1) engineering:readScorecardsaiuby scorecards list
GET /api/v1/engineering/portal/scorecards/{id}Ler a engenharia (API v1) engineering:readRelatório de um scorecardaiuby scorecards get <id>
GET /api/v1/engineering/portal/adoptionLer a engenharia (API v1) engineering:readAdoção do Developer Portalaiuby portal adoption