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
| Rota | Escopo | Para quê | CLI |
|---|---|---|---|
GET /api/v1/engineering/catalog | Ler a engenharia (API v1) engineering:read | Lista o catálogo de engenharia | aiuby graph services |
GET /api/v1/engineering/entities/{id} | Ler a engenharia (API v1) engineering:read | Entidade e vizinhança | aiuby graph entity <id> |
GET /api/v1/engineering/events | Ler a engenharia (API v1) engineering:read | Eventos recentes | aiuby graph events |
POST /api/v1/engineering/query | Ler a engenharia (API v1) engineering:read | Consulta estruturada ao grafo | aiuby graph ask |
#Engineering Intelligence
Exemplos e o que ainda não existe: Engineering Intelligence.
| Rota | Escopo | Para quê | CLI |
|---|---|---|---|
GET /api/v1/engineering/insights/delivery | Ler a engenharia (API v1) engineering:read | Indicadores de entrega | aiuby insights delivery |
GET /api/v1/engineering/dora | Ler a engenharia (API v1) engineering:read | Indicadores DORA | aiuby dora |
GET /api/v1/engineering/ai-efficiency | Ler a engenharia (API v1) engineering:read | Adoção e gasto de ferramentas de IA | aiuby ai-efficiency |
GET /api/v1/engineering/intel | Ler a engenharia (API v1) engineering:read | Inteligência de engenharia por time | aiuby intel |
POST /api/v1/engineering/work-items | Enviar itens de trabalho (tickets) engineering:ingest | Enviar itens de trabalho (tickets) | aiuby work-items push |
GET /api/v1/code-review/reviews | Ler a engenharia (API v1) engineering:read | Revisões de PR por IA | aiuby code-review list |
GET /api/v1/code-review/reviews/{id} | Ler a engenharia (API v1) engineering:read | Uma revisão de PR | aiuby code-review get <id> |
GET /api/v1/code-review/check | Ler a engenharia (API v1) engineering:read | Portão de revisão de um PR (para o CI) | aiuby code-review check |
GET /api/v1/code-review/branch-policy | Ler a engenharia (API v1) engineering:read | Política de branch conferida no GitHub | aiuby code-review branch-policy |
GET /api/v1/code-review/metrics | Ler a engenharia (API v1) engineering:read | Métricas da revisão por IA | aiuby code-review metrics |
#Incident Management
Exemplos e o que ainda não existe: Incident Management.
| Rota | Escopo | Para quê | CLI |
|---|---|---|---|
GET /api/v1/engineering/slos | Ler a engenharia (API v1) engineering:read | Lista os SLOs | aiuby slos list |
GET /api/v1/engineering/slos/{id} | Ler a engenharia (API v1) engineering:read | Estado de um SLO | aiuby slos get <id> |
GET /api/v1/engineering/slo-composites | Ler a engenharia (API v1) engineering:read | Lista os SLOs compostos | aiuby slos composites |
GET /api/v1/engineering/slo-composites/{id} | Ler a engenharia (API v1) engineering:read | Estado de um SLO composto | aiuby slos composite <id> |
GET /api/v1/engineering/incidents | Ler a engenharia (API v1) engineering:read | Incidentes | aiuby incidents list |
GET /api/v1/engineering/incidents/{id} | Ler a engenharia (API v1) engineering:read | Um incidente | aiuby incidents get <id> |
GET /api/v1/engineering/runbooks | Ler a engenharia (API v1) engineering:read | Runbooks | aiuby runbooks list |
GET /api/v1/engineering/runbooks/{id} | Ler a engenharia (API v1) engineering:read | Um runbook | aiuby 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).
| Rota | Escopo | Para quê | CLI |
|---|---|---|---|
POST /api/v1/engineering/security/sarif | Enviar SARIF e SBOM do CI security:write | Envia resultado SARIF 2.1.0 | aiuby security upload-sarif |
POST /api/v1/engineering/security/sbom | Enviar SARIF e SBOM do CI security:write | Envia SBOM externo | aiuby security upload-sbom |
GET /api/v1/engineering/security/findings | Ler a engenharia (API v1) engineering:read | Achados dos scanners | aiuby security findings |
GET /api/v1/engineering/security/gate | Ler 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/scans | Ler a engenharia (API v1) engineering:read | Scans de segurança | aiuby security scans |
POST /api/v1/engineering/security/scans | Pedir scan de segurança (agente de código) security:scan | Pede um scan pelo CI | aiuby security scan |
GET /api/v1/engineering/security/scans/{id} | Ler a engenharia (API v1) engineering:read | Um scan e os achados dele | aiuby security scans get <id> |
GET /api/v1/engineering/sbom | Ler a engenharia (API v1) engineering:read | SBOMs dos scans | aiuby sbom get |
GET /api/v1/engineering/sbom/where | Ler a engenharia (API v1) engineering:read | Onde usamos um pacote ou vulnerabilidade | aiuby sbom where |
GET /api/v1/engineering/sbom/{id} | Ler a engenharia (API v1) engineering:read | Um SBOM e os componentes | aiuby sbom get |
GET /api/v1/engineering/sbom/{id}/export | Ler a engenharia (API v1) engineering:read | Exportar SBOM (CycloneDX ou SPDX) | aiuby sbom get --format |
#Test Automation
Exemplos e o que ainda não existe: Test Automation.
| Rota | Escopo | Para quê | CLI |
|---|---|---|---|
GET /api/v1/engineering/test-plans | Ler a engenharia (API v1) engineering:read | Planos de teste declarativos | aiuby test-plans list |
POST /api/v1/tests/runs | Rodar suítes Playwright no CI tests:run | Disparar 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:run | Estado de uma execução de suíte | aiuby tests status <id> |
#Software Delivery
Exemplos e o que ainda não existe: Software Delivery.
| Rota | Escopo | Para quê | CLI |
|---|---|---|---|
GET /api/v1/engineering/artifacts/repositories | Ler a engenharia (API v1) engineering:read | Repositórios de artefatos | aiuby artifacts list |
GET /api/v1/engineering/artifacts | Ler a engenharia (API v1) engineering:read | Artefatos | aiuby artifacts list |
GET /api/v1/engineering/artifacts/versions | Ler a engenharia (API v1) engineering:read | Versões e tags | aiuby artifacts tags |
GET /api/v1/engineering/artifacts/versions/{id} | Ler a engenharia (API v1) engineering:read | Uma versão | — |
POST /api/v1/engineering/artifacts/credentials | Implantar no Compute (CLI) compute:deploy | Credencial de push/pull | aiuby artifacts login |
POST /api/v1/iac/check | Check de IaC no CI iac:check | Check de IaC de um PR (portão do CI) | aiuby iac check |
GET /api/v1/iac/check/{id} | Check de IaC no CI iac:check | Estado de um check de IaC | aiuby iac check --wait |
POST /api/v1/iac/applied | Check de IaC no CI iac:check | Registrar o apply feito pelo CI | aiuby iac applied |
POST /api/v1/db/check | Check de migrações no CI db:check | Check 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:check | Estado de um check de migrações | aiuby db check --wait |
POST /api/v1/iac/runs | Rodar plan e apply gerenciados de IaC iac:run | Disparar um plan gerenciado de IaC | aiuby iac plan |
GET /api/v1/iac/runs | Rodar plan e apply gerenciados de IaC iac:run | Execuções de IaC | aiuby iac runs |
GET /api/v1/iac/runs/{id} | Rodar plan e apply gerenciados de IaC iac:run | Estado de uma execução de IaC | aiuby iac run <id> |
POST /api/v1/iac/runs/{id}/apply | Rodar plan e apply gerenciados de IaC iac:run | Aplicar um plan aprovado | aiuby iac apply <id> |
GET /api/v1/iac/runs/{id}/insight | Rodar plan e apply gerenciados de IaC iac:run | Custo estimado e raio de impacto de um plan | aiuby iac insight <id> |
GET /api/v1/iac/runs/report | Rodar plan e apply gerenciados de IaC iac:run | Relatório do histórico de IaC por workspace | aiuby iac report |
GET /api/v1/db/databases | Ler o histórico de bancos e migrações db:read | Bancos cadastrados | aiuby db databases |
GET /api/v1/db/migrations | Ler o histórico de bancos e migrações db:read | Histórico de migrações de um banco | aiuby db migrations <banco> |
POST /api/v1/db/migrations | Relatar migrações de banco no CI db:report | Relatar uma migração aplicada, desfeita ou que falhou | aiuby db report |
POST /api/v1/db/migrations/gate | Relatar migrações de banco no CI db:report | Portão antes de aplicar migrações | aiuby db gate |
POST /api/v1/db/schema-snapshots | Relatar migrações de banco no CI db:report | Enviar o retrato do schema de um banco | aiuby db snapshot |
GET /api/v1/db/schema-diff | Ler o histórico de bancos e migrações db:read | Diferença de schema entre dois bancos | aiuby db schema-diff |
GET /api/v1/delivery/releases | Ler a engenharia (API v1) engineering:read (ou delivery:approve, delivery:rollback) | Releases de entrega em Kubernetes | aiuby releases list |
GET /api/v1/delivery/releases/{id} | Ler a engenharia (API v1) engineering:read (ou delivery:approve, delivery:rollback) | Estado de uma release | aiuby releases get <id> |
POST /api/v1/delivery/releases/{id}/approve | Aprovar estágios de release (CLI) delivery:approve | Aprovar o estágio que espera aprovação | aiuby releases approve <id> |
POST /api/v1/delivery/releases/{id}/rollback | Voltar releases (CLI) delivery:rollback | Voltar uma release | aiuby releases rollback <id> |
POST /api/v1/delivery/agent/sync | delivery:agent | Agente de entrega: relatar e buscar o estado desejado | — |
POST /api/v1/deploy/vm-agent/sync | delivery:agent | Agente da VM: relatar e buscar a imagem a rodar | — |
GET /api/v1/pipelines | Ler a engenharia (API v1) engineering:read | Pipelines de CI | aiuby pipelines list |
GET /api/v1/pipelines/templates | Ler a engenharia (API v1) engineering:read | Modelos de pipeline | aiuby pipelines templates |
GET /api/v1/pipelines/{id}/variables | Ler a engenharia (API v1) engineering:read | Variáveis e segredos de um pipeline (só nomes) | aiuby pipelines variables <id> |
GET /api/v1/pipelines/{id}/runs | Ler a engenharia (API v1) engineering:read | Execuções de um pipeline | aiuby pipelines runs <id> |
GET /api/v1/pipelines/runs/{id} | Ler a engenharia (API v1) engineering:read | Uma execução de pipeline | aiuby pipelines run <id> |
POST /api/v1/pipelines/runs/{id}/approval | Aprovar estágios de release (CLI) delivery:approve | Aprovar 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.
| Rota | Escopo | Para quê | CLI |
|---|---|---|---|
GET /api/v1/engineering/flags | Ler a engenharia (API v1) engineering:read | Feature flags | aiuby flags list |
GET /api/v1/engineering/flag-cleanup | Ler a engenharia (API v1) engineering:read | Flags candidatas a limpeza | aiuby flags cleanup |
#AI Engineering
Exemplos e o que ainda não existe: AI Engineering.
| Rota | Escopo | Para quê | CLI |
|---|---|---|---|
GET /api/v1/skills | Baixar skills publicadas skills:read | Skills publicadas | aiuby skills list |
GET /api/v1/skills/{name} | Baixar skills publicadas skills:read | Baixar uma skill | aiuby skills get <nome> |
GET /api/v1/agents/{id}/eval-cases | Avaliações de agentes (SDK e MCP) agents:eval | Casos da suíte de avaliação de um agente | aiuby evals cases <agente> |
POST /api/v1/agents/{id}/eval-cases | Avaliações de agentes (SDK e MCP) agents:eval | Criar caso de avaliação | aiuby evals add-case <agente> |
GET /api/v1/agents/{id}/evaluations | Avaliações de agentes (SDK e MCP) agents:eval | Última avaliação do agente | aiuby evals latest <agente> |
POST /api/v1/agents/{id}/evaluations | Avaliações de agentes (SDK e MCP) agents:eval | Rodar a suíte de avaliação | aiuby evals run <agente> |
GET /api/v1/evaluations/{id} | Avaliações de agentes (SDK e MCP) agents:eval | Resultado de uma avaliação | aiuby evals get <id> |
POST /api/v1/otel/v1/traces | Traces de agentes externos (OpenTelemetry) agents:trace | Ingestã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).
| Rota | Escopo | Para quê | CLI |
|---|---|---|---|
POST /api/v1/api-security/traffic | Enviar tráfego de APIs (log do gateway) api-security:ingest | Enviar tráfego observado (log do gateway ou espelhamento) | aiuby apis traffic |
GET /api/v1/api-security/applications | Ler a engenharia (API v1) engineering:read | Aplicações do inventário de APIs | aiuby apis applications |
GET /api/v1/api-security/policies | Ler a engenharia (API v1) engineering:read | Políticas configuráveis de postura | aiuby apis policies |
GET /api/v1/api-security/apis/{id}/spec | Ler a engenharia (API v1) engineering:read | OpenAPI gerado do inventário | aiuby apis spec <id> |
GET /api/v1/api-security/apis | Ler a engenharia (API v1) engineering:read | Inventário de APIs | aiuby apis list |
GET /api/v1/api-security/apis/{id} | Ler a engenharia (API v1) engineering:read | Uma API do inventário | aiuby apis get <id> |
GET /api/v1/api-security/apis/{id}/drift | Ler a engenharia (API v1) engineering:read | Drift da especificação | aiuby apis drift <id> |
GET /api/v1/api-security/findings | Ler a engenharia (API v1) engineering:read | Achados de postura de API | aiuby apis findings |
GET /api/v1/api-protection/protections | Ler a engenharia (API v1) engineering:read | Proteções de API | aiuby api-protection list |
GET /api/v1/api-protection/protections/{id} | Ler a engenharia (API v1) engineering:read | Uma proteção de API | aiuby api-protection get <id> |
GET /api/v1/api-protection/protections/{id}/stats | Ler a engenharia (API v1) engineering:read | Estatísticas de uma proteção | aiuby api-protection stats <id> |
GET /api/v1/api-protection/protections/{id}/samples | Ler a engenharia (API v1) engineering:read | Amostras redigidas de uma proteção | aiuby api-protection samples <id> |
#Resilience Testing
Exemplos e o que ainda não existe: Resilience Testing.
| Rota | Escopo | Para quê | CLI |
|---|---|---|---|
GET /api/v1/load-tests/scenarios | Teste de carga (pipeline e Terraform) load-test:run | Cenários de carga do workspace | aiuby load-tests scenarios list |
POST /api/v1/load-tests/scenarios | Teste de carga (pipeline e Terraform) load-test:run | Criar 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:run | Um cenário de carga | aiuby load-tests scenarios get <id> |
DELETE /api/v1/load-tests/scenarios/{id} | Teste de carga (pipeline e Terraform) load-test:run | Remover cenário de carga | aiuby load-tests scenarios delete <id> |
POST /api/v1/load-tests/runs | Teste de carga (pipeline e Terraform) load-test:run | Disparar 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:run | Estado e veredito do teste de carga | aiuby load-tests status <id> |
POST /api/v1/resilience/check | Check de resiliência no CI resilience:check | Check 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.
| Rota | Escopo | Para quê | CLI |
|---|---|---|---|
GET /api/v1/code-automation/tickets | Ler a engenharia (API v1) engineering:read | Tickets do Code Automation | aiuby tickets list |
GET /api/v1/code/search | Ler a engenharia (API v1) engineering:read | Busca de código | aiuby code search |
#Developer Portal
Exemplos e o que ainda não existe: Developer Portal.
| Rota | Escopo | Para quê | CLI |
|---|---|---|---|
GET /api/v1/engineering/portal/services | Ler a engenharia (API v1) engineering:read | Catálogo do Developer Portal | aiuby catalog list |
GET /api/v1/engineering/portal/services/{id} | Ler a engenharia (API v1) engineering:read | Serviço e notas dos scorecards | aiuby catalog get <id> |
GET /api/v1/engineering/portal/scorecards | Ler a engenharia (API v1) engineering:read | Scorecards | aiuby scorecards list |
GET /api/v1/engineering/portal/scorecards/{id} | Ler a engenharia (API v1) engineering:read | Relatório de um scorecard | aiuby scorecards get <id> |
GET /api/v1/engineering/portal/adoption | Ler a engenharia (API v1) engineering:read | Adoção do Developer Portal | aiuby portal adoption |