Pular para conteúdo

Endpoints da API

Referência gerada de docs/api/openapi.json (OpenAPI 3.1.0, Quantix Vision AI API 8.3.0): 154 caminhos, 201 operações. A especificação interativa (Swagger) fica em /api/docs e a ReDoc em /api/redoc na própria instalação; o JSON em /api/openapi.json.

Legenda: parâmetro com * é de caminho; os demais são de consulta (query string). Permissão é a exigida pelo endpoint (ver Permissões e papéis); autenticado = qualquer usuário com sessão ou token de API; token de coletor = cabeçalho X-Collector-Token; pública = sem autenticação.

Autenticação

Método Caminho Descrição Parâmetros Corpo Permissão
POST /api/v1/auth/login Autentica (base local ou diretório) e devolve access/refresh token; grava cookie qv_refresh. — LoginIn pública
POST /api/v1/auth/logout Remove o cookie de refresh. — RefreshIn (opcional) pública
GET /api/v1/auth/me Perfil, papéis e permissões efetivas do usuário atual. — — autenticado
POST /api/v1/auth/password Troca a própria senha (somente usuários locais). — PasswordIn autenticado
PUT /api/v1/auth/preferences Grava preferências do usuário (tema, período etc.). — PrefsIn autenticado
GET /api/v1/auth/providers Métodos de login exibidos na tela de entrada (base local, diretórios). — — pública
POST /api/v1/auth/refresh Renova o access token a partir do refresh token (corpo ou cookie). — RefreshIn (opcional) pública
GET /api/v1/auth/tokens Lista os tokens de API do usuário. — — autenticado
POST /api/v1/auth/tokens Cria token de API qv_... (exibido uma única vez). — TokenIn autenticado
DELETE /api/v1/auth/tokens/{token_id} Revoga um token de API do usuário. token_id* — autenticado

Dados

Método Caminho Descrição Parâmetros Corpo Permissão
GET /api/v1/catalog Catálogo de tipos de objeto, relações e métricas. — — view
GET /api/v1/changes Mudanças de configuração com filtros. device_id, change, offset, limit — view
GET /api/v1/entities Lista objetos do inventário com filtros (tipo, nome, dispositivo, saúde, tag). type, q, device_id, parent_id, health, tag, sort, offset, limit — view
GET /api/v1/entities/{entity_id} Detalhe do objeto: atributos, hierarquia, saúde, achados, identificadores. entity_id* — view
POST /api/v1/entities/{entity_id}/breakdown Drill-down: quais recursos filhos/relacionados compõem esta métrica, para ir detalhando. entity_id* BreakdownIn view
GET /api/v1/entities/{entity_id}/changes Mudanças de configuração do objeto (ou do dispositivo, para sistemas). entity_id*, limit — view
POST /api/v1/entities/{entity_id}/metrics Séries de várias métricas (até 16) de um objeto. entity_id* EntityMetricsIn view
GET /api/v1/health/children/{entity_id} Saúde dos componentes de um sistema (drill-down). entity_id* — view
GET /api/v1/health/map Mapa de saúde por tipo de objeto. types — view
POST /api/v1/metrics/export.csv Exporta o resultado de uma consulta em CSV (separador ;). — QueryIn view
POST /api/v1/metrics/query Consulta analítica de métricas (timeseries, topn, latest, stat, heatmap, distribution). — QueryIn view
GET /api/v1/overview Resumo do ambiente: contagens, saúde, achados, dispositivos e capacidade. — — view
GET /api/v1/search Busca global por nome (trigram), WWPN/NAA/serial e dispositivo. q, limit — view
GET /api/v1/topology/{entity_id} Grafo de topologia ao redor do objeto (depth ≤ 12, max_nodes ≤ 1000). entity_id*, depth, max_nodes — view

Insights

Método Caminho Descrição Parâmetros Corpo Permissão
GET /api/v1/findings Lista achados com filtros e paginação, ordenados por prioridade. status, severity, category, entity_id, device_id, q, offset, limit — view
GET /api/v1/findings/summary Contagem de achados abertos por categoria e severidade. — — view
GET /api/v1/findings/{fid} Detalhe de um achado. fid* — view
PUT /api/v1/findings/{fid} Muda status, responsável ou adiciona nota a um achado. fid* FindingUpdate findings.manage
GET /api/v1/forecasts Previsões de capacidade (dias até 80/90/100%). entity_type, max_days, limit — view
GET /api/v1/reports Lista relatórios (resumo executivo diário). kind, limit — view
GET /api/v1/reports/{rid} Conteúdo Markdown de um relatório. rid* — view

Dashboards e aplicações

Método Caminho Descrição Parâmetros Corpo Permissão
GET /api/v1/applications Lista aplicações de negócio com saúde. — — view
POST /api/v1/applications Cria aplicação (regras e membros manuais). — ApplicationIn applications.manage
POST /api/v1/applications/preview Pré-visualiza os objetos que as regras selecionariam. — ApplicationIn view
GET /api/v1/applications/{aid} Detalhe da aplicação e membros. aid* — view
PUT /api/v1/applications/{aid} Altera aplicação. aid* ApplicationIn applications.manage
DELETE /api/v1/applications/{aid} Exclui aplicação (membros não são afetados). aid* — applications.manage
GET /api/v1/dashboards Dashboards visíveis ao usuário (próprios, compartilhados e de sistema). — — view
POST /api/v1/dashboards Cria dashboard (compartilhar exige dashboards.manage). — DashboardIn view
GET /api/v1/dashboards/{did} Dashboard com widgets e can_edit. did* — view
PUT /api/v1/dashboards/{did} Altera dashboard (dono ou dashboards.manage). did* DashboardIn view
DELETE /api/v1/dashboards/{did} Exclui dashboard (exceto de sistema). did* — view
POST /api/v1/dashboards/{did}/clone Duplica dashboard para “Meus dashboards”. did* — view

Coleta

Método Caminho Descrição Parâmetros Corpo Permissão
GET /api/v1/collector/config Dispositivos atribuídos ao coletor, com credenciais. — — token de coletor
POST /api/v1/collector/heartbeat Heartbeat do coletor (versão, host, estatísticas). — quantix__api__routers__devices__HeartbeatIn token de coletor
GET /api/v1/collector/plugins Plugins enviados, para o coletor sincronizar localmente. — — token de coletor
POST /api/v1/collector/status Resultados de ciclos de coleta por dispositivo. — StatusIn (lista) token de coletor
GET /api/v1/collector/tasks Tarefas pendentes do coletor (testar, coletar agora, recarregar). — — token de coletor
POST /api/v1/collector/tasks/{task_id} Resultado de uma tarefa do coletor. task_id* TaskResult token de coletor
GET /api/v1/collectors Lista coletores com status derivado do heartbeat. — — view
POST /api/v1/collectors Registra coletor e devolve token e comando de instalação. — CollectorIn pública
GET /api/v1/collectors/health Resumo de utilização dos coletores e quantos coletores adicionais são recomendados. — — view
PUT /api/v1/collectors/{cid} Altera coletor. cid* CollectorIn pública
DELETE /api/v1/collectors/{cid} Exclui coletor sem dispositivos. cid* — pública
POST /api/v1/collectors/{cid}/deploy Implanta o coletor cid em um host Linux remoto via SSH (sem docker run manual). cid* DeployCollectorIn pública
POST /api/v1/collectors/{cid}/token Gera novo token do coletor (o anterior deixa de valer). cid* — pública
GET /api/v1/credentials Lista perfis de credencial (sem segredos). — — view
POST /api/v1/credentials Cria perfil de credencial (segredos cifrados). — CredentialIn credentials.manage
PUT /api/v1/credentials/{cid} Altera credencial (campos secretos vazios mantêm os atuais). cid* CredentialIn credentials.manage
DELETE /api/v1/credentials/{cid} Exclui credencial não utilizada. cid* — credentials.manage
GET /api/v1/devices Lista dispositivos monitorados. q, category, status, offset, limit — view
POST /api/v1/devices Cadastra dispositivo e notifica o coletor. — DeviceIn devices.manage
POST /api/v1/devices/import Cadastro em lote (até 5.000 itens) com erro por linha. — ImportIn devices.manage
POST /api/v1/devices/test Testa a conexão de um dispositivo ainda não salvo. — TestIn devices.manage
GET /api/v1/devices/{device_id} Detalhe do dispositivo com contagem de objetos por tipo. device_id* — view
PUT /api/v1/devices/{device_id} Altera dispositivo. device_id* DeviceIn devices.manage
DELETE /api/v1/devices/{device_id} Exclui dispositivo e seu inventário. device_id*, purge_data — devices.manage
POST /api/v1/devices/{device_id}/collect Solicita coleta imediata ao coletor. device_id* — devices.manage
POST /api/v1/devices/{device_id}/test Testa a conexão (pelo coletor atribuído ou from_server). device_id* TestIn (opcional) devices.manage
POST /api/v1/ingest/inventory Ingestão HTTPS de snapshot de inventário (msgpack+zlib). — — token de coletor
POST /api/v1/ingest/metrics Ingestão HTTPS de lote de métricas (msgpack, zlib opcional). — — token de coletor
GET /api/v1/plugins Catálogo de plugins de coleta (portas, opções, requisitos). — — view

Alertas e automação

Método Caminho Descrição Parâmetros Corpo Permissão
GET /api/v1/alerts/channels Lista canais de alerta (segredos mascarados). — — pública
POST /api/v1/alerts/channels Cria canal (webhook, teams, slack, email, syslog, servicenow). — ChannelIn pública
PUT /api/v1/alerts/channels/{cid} Altera canal. cid* ChannelIn pública
DELETE /api/v1/alerts/channels/{cid} Exclui canal. cid* — pública
POST /api/v1/alerts/channels/{cid}/test Envia mensagem de teste pelo canal. cid* — pública
GET /api/v1/alerts/email-queue Histórico recente da fila de e-mail (status, tentativas, último erro). status — pública
GET /api/v1/alerts/rules Lista regras de alerta. — — view
POST /api/v1/alerts/rules Cria regra (severidade mínima, categorias, tipos, canais, runbook). — RuleIn pública
PUT /api/v1/alerts/rules/{rid} Altera regra. rid* RuleIn pública
DELETE /api/v1/alerts/rules/{rid} Exclui regra. rid* — pública
POST /api/v1/alerts/test-email Envia um e-mail de teste com o SMTP atual e devolve um diagnóstico claro em caso de erro. — TestEmailIn pública
GET /api/v1/automation/jobs Lista execuções (filtro por status). status, offset, limit — view
POST /api/v1/automation/jobs Solicita execução de runbook. — JobIn automation.request
GET /api/v1/automation/jobs/{jid} Detalhe e saída de uma execução. jid* — view
POST /api/v1/automation/jobs/{jid}/decision Aprova ou rejeita execução (segregação de funções). jid* Decision pública
GET /api/v1/automation/playbooks Catálogo de runbooks. — — view
PUT /api/v1/automation/playbooks/{pid} Ativa/desativa runbook ou muda exigência de aprovação. pid* PlaybookPatch pública

Inteligência artificial

Método Caminho Descrição Parâmetros Corpo Permissão
POST /api/v1/ai/ask Pergunta ao assistente (ferramentas sobre dados reais, escopo de tenant). — AskIn ai.use
POST /api/v1/ai/findings/{fid}/explain Explicação de achado pela IA (com cache; sem IA devolve o texto da engine). fid* — ai.use
GET /api/v1/ai/sessions Conversas do usuário com o assistente. — — ai.use
GET /api/v1/ai/sessions/{sid} Mensagens de uma conversa. sid* — ai.use
DELETE /api/v1/ai/sessions/{sid} Exclui conversa. sid* — ai.use
GET /api/v1/ai/status Estado da IA (habilitada, provedor, modelo, anonimização). — — view

Administração

Método Caminho Descrição Parâmetros Corpo Permissão
GET /api/v1/admin/audit Consulta o log de auditoria. q, action, offset, limit — pública
GET /api/v1/admin/directories Lista diretórios LDAP/AD. — — pública
POST /api/v1/admin/directories Cadastra diretório LDAP/AD/FreeIPA. — DirectoryIn pública
GET /api/v1/admin/directories/defaults Filtros e atributos padrão por tipo de diretório. — — pública
PUT /api/v1/admin/directories/{dir_id} Altera diretório (senha de bind vazia mantém a atual). dir_id* DirectoryIn pública
DELETE /api/v1/admin/directories/{dir_id} Exclui diretório. dir_id* — pública
POST /api/v1/admin/directories/{dir_id}/test Testa bind da conta de serviço e, opcionalmente, a busca de um usuário. dir_id* DirTestIn pública
GET /api/v1/admin/permissions Catálogo de permissões. — — pública
GET /api/v1/admin/roles Lista papéis. — — pública
POST /api/v1/admin/roles Cria papel personalizado. — RoleIn pública
PUT /api/v1/admin/roles/{role_id} Altera papel personalizado (papéis padrão são imutáveis). role_id* RoleIn pública
DELETE /api/v1/admin/roles/{role_id} Exclui papel personalizado. role_id* — pública
GET /api/v1/admin/settings Variáveis da plataforma com tipo, faixa e valor (segredos mascarados). — — view
PUT /api/v1/admin/settings Altera variáveis (validação por faixa; retenção reaplica TTL no ClickHouse). — SettingsPatch pública
GET /api/v1/admin/tenants Lista tenants. — — view
POST /api/v1/admin/tenants Cria tenant. — TenantIn pública
PUT /api/v1/admin/tenants/{tenant_id} Altera tenant. tenant_id* TenantIn pública
DELETE /api/v1/admin/tenants/{tenant_id} Exclui tenant (mantém pelo menos um). tenant_id* — pública
GET /api/v1/admin/thresholds Lista exceções de threshold e métricas avaliadas. — — pública
POST /api/v1/admin/thresholds Cria exceção de threshold (objeto, dispositivo ou tipo). — OverrideIn pública
PUT /api/v1/admin/thresholds/{oid} Altera exceção de threshold. oid* OverrideIn pública
DELETE /api/v1/admin/thresholds/{oid} Remove exceção de threshold. oid* — pública
GET /api/v1/admin/tls Certificado HTTPS gerenciado pela GUI e se o volume de certificados está disponível. — — pública
POST /api/v1/admin/tls Valida (apply: false) ou instala um certificado PEM/PFX; o nginx recarrega em até 15 s. — TlsIn pública
GET /api/v1/admin/users Lista usuários (busca e paginação). q, offset, limit — pública
POST /api/v1/admin/users Cria usuário local (senha temporária se omitida). — UserIn pública
PUT /api/v1/admin/users/{user_id} Altera usuário, papéis, senha ou desbloqueia (unlock). user_id* UserUpdate pública
DELETE /api/v1/admin/users/{user_id} Exclui usuário (preserva o último superadministrador). user_id* — pública

Sistema

Método Caminho Descrição Parâmetros Corpo Permissão
GET /api/health Liveness/readiness: PostgreSQL e banco de séries. — — pública
GET /api/v1/system/about Produto e versão. — — pública
GET /api/v1/system/status Estado da plataforma: dispositivos, coletores, tabelas do ClickHouse, ingestão. — — pública

Relatórios

Método Caminho Descrição Parâmetros Corpo Permissão
GET /api/v1/branding Get Branding — — view
GET /api/v1/branding/logo Get Logo — — view
PUT /api/v1/branding/logo Put Logo — LogoIn pública
DELETE /api/v1/branding/logo Delete Logo — — pública
GET /api/v1/reports-topics Report Topics — — view
POST /api/v1/reports/generate Generate — GenerateIn ai.use
DELETE /api/v1/reports/{rid} Delete Report rid* — pública
GET /api/v1/reports/{rid}/pdf Report Pdf rid* — view

Manutenção

Método Caminho Descrição Parâmetros Corpo Permissão
GET /api/v1/admin/backup-targets List Targets — — pública
POST /api/v1/admin/backup-targets Create Target — TargetIn pública
PUT /api/v1/admin/backup-targets/{tid} Update Target tid* TargetIn pública
DELETE /api/v1/admin/backup-targets/{tid} Delete Target tid* — pública
POST /api/v1/admin/backup-targets/{tid}/send/{bid} Envia um backup existente para o destino (com criptografia/integridade/retenção). tid, bid — pública
POST /api/v1/admin/backup-targets/{tid}/test Testa a conexão com o destino (grava/lê/apaga um arquivo de teste), com diagnóstico claro. tid* — pública
GET /api/v1/admin/backups List Backups — — pública
POST /api/v1/admin/backups Create Backup — BackupIn pública
POST /api/v1/admin/backups/upload Upload Backup — Body_upload_backup_api_v1_admin_backups_upload_post pública
DELETE /api/v1/admin/backups/{bid} Delete Backup bid* — pública
GET /api/v1/admin/backups/{bid}/download Download Backup bid* — pública
POST /api/v1/admin/backups/{bid}/restore Restore Backup bid* RestoreIn pública
GET /api/v1/admin/data/orphans Orphans — — pública
POST /api/v1/admin/data/orphans/purge Purge — — pública
GET /api/v1/admin/pg-advisor Lê o pg_settings do banco conectado e compara com as recomendações do porte, com os scripts prontos. tier — pública
GET /api/v1/admin/versions Versions — — pública

Primeira execução

Método Caminho Descrição Parâmetros Corpo Permissão
POST /api/v1/setup/admin Cria (ou atualiza) o primeiro administrador local. — AdminIn pública
POST /api/v1/setup/complete Conclui o assistente (rotas passam a responder 410) e devolve a sessão do administrador. — — pública
POST /api/v1/setup/directory Grava o diretório AD/LDAP com o mapeamento grupos → papéis. — SetupDirectoryIn pública
POST /api/v1/setup/directory/test Testa bind e busca de usuário no diretório sem gravar. — SetupDirectoryIn pública
POST /api/v1/setup/organization Grava nome da instalação, URL pública, fuso horário e idioma. — OrgIn pública
POST /api/v1/setup/smtp Grava o servidor SMTP. — SmtpIn pública
POST /api/v1/setup/smtp/test Envia e-mail de teste com os dados informados, sem gravar. — SmtpIn pública
GET /api/v1/setup/state Estado completo do assistente (resumos e valores sugeridos); exige o token. — — pública
GET /api/v1/setup/status Público. Indica se o assistente de primeira execução é necessário e quais etapas foram feitas. — — pública
GET /api/v1/setup/tls Certificado atualmente gerenciado pela GUI (se houver). — — pública
POST /api/v1/setup/tls Valida ou instala o certificado HTTPS (PEM com cadeia e chave, ou PFX/P12). — TlsIn pública
POST /api/v1/setup/verify Confere o token de instalação (X-Setup-Token). — — pública
POST /api/v1/setup/{step}/skip Pula uma etapa opcional (tls, directory, smtp); etapas já configuradas são mantidas. step* — pública

Licença

Método Caminho Descrição Parâmetros Corpo Permissão
GET /api/v1/license Estado da licença. Usuários comuns veem o necessário para os avisos; superadmin vê tudo. — — autenticado
POST /api/v1/license Apply License — LicenseIn pública
DELETE /api/v1/license Remove License — — pública

Descoberta

Método Caminho Descrição Parâmetros Corpo Permissão
POST /api/v1/collector/discovery/{task_id}/progress Discovery Progress task_id* ProgressIn token de coletor
GET /api/v1/discovery/jobs List Jobs — — pública
POST /api/v1/discovery/jobs Start Job — DiscoveryIn pública
GET /api/v1/discovery/jobs/{job_id} Get Job job_id* — pública
DELETE /api/v1/discovery/jobs/{job_id} Delete Job job_id* — pública
POST /api/v1/discovery/jobs/{job_id}/cancel Cancel Job job_id* — pública
GET /api/v1/discovery/jobs/{job_id}/prefill Dados para abrir o assistente de dispositivo já preenchido (plugin, endereço, nome, porta, coletor). job_id*, ip, plugin — pública
GET /api/v1/discovery/profiles Profiles — — pública

Plataforma

Método Caminho Descrição Parâmetros Corpo Permissão
GET /api/v1/admin/platform Overview — — —
GET /api/v1/admin/platform/agent Estado do agente do host e dados para instalá-lo/conectá-lo pela interface. — — —
GET /api/v1/admin/platform/agent/install-script Instalador bash autocontido (com o token, só superadmin): baixa e roda no host como root. — — —
GET /api/v1/admin/platform/operations List Operations limit — —
POST /api/v1/admin/platform/operations Create Operation — OperationIn —
GET /api/v1/admin/platform/operations/{op_id} Get Operation op_id*, tail — —
POST /api/v1/admin/platform/operations/{op_id}/cancel Cancel Operation op_id* — —
GET /api/v1/admin/platform/packages Packages — — —
POST /api/v1/admin/platform/packages Recebe o .zip da nova versão como corpo bruto (application/zip), sem bufferizar em memória. filename — —
DELETE /api/v1/admin/platform/packages/{pid} Delete Package pid* — —
POST /api/v1/admin/platform/sizing Sizing Plan — SizingIn —

Agente do host

Método Caminho Descrição Parâmetros Corpo Permissão
POST /api/v1/agent/heartbeat Heartbeat — quantix__api__routers__platform__HeartbeatIn pública
POST /api/v1/agent/operations/next Next Operation — NextIn pública
POST /api/v1/agent/operations/{op_id}/finish Finish Operation op_id* FinishIn pública
POST /api/v1/agent/operations/{op_id}/log Append Log op_id* LogIn pública
GET /api/v1/agent/operations/{op_id}/package Download Package op_id* — pública
GET /api/v1/agent/program Programa do agente + unidade systemd, para o instalador baixar quando a pasta da instalação — — pública

Diagnóstico

Método Caminho Descrição Parâmetros Corpo Permissão
GET /api/v1/admin/diagnostics Diagnostics — — pública
POST /api/v1/admin/selfcheck Autodiagnóstico sob demanda ("Diagnosticar agora", Fase 3): roda as verificações, grava os — — pública

Plugins

Método Caminho Descrição Parâmetros Corpo Permissão
GET /api/v1/admin/plugins Plugins instalados (embutidos + enviados), com a origem de cada um. — — pública
POST /api/v1/admin/plugins/upload Envia e instala um plugin de coleta (.py) pela interface. filename — pública
DELETE /api/v1/admin/plugins/{key} Remove um plugin enviado pela interface. key* — pública

Importação de devices

Método Caminho Descrição Parâmetros Corpo Permissão
GET /api/v1/admin/import-profiles List Profiles — — pública
POST /api/v1/admin/import-profiles Create Profile — ProfileIn pública
DELETE /api/v1/admin/import-profiles/{pid} Delete Profile pid* — pública
POST /api/v1/admin/third-party-import Upload de um arquivo PARM/CSV. dry_run (padrão) só pré-visualiza; senão cria os devices novos. — Body_third_party_import_api_v1_admin_third_party_import_post pública
GET /api/v1/admin/third-party-import/template.csv Template CSV próprio do Quantix (útil para clientes sem PARM). — — pública

Schemas de entrada

Campos dos corpos de requisição (obrigatórios em negrito).

Schema Campos
AdminIn username, display_name, email, password
ApplicationIn name, description, criticality, owner, rules, members
AskIn question, session_id, context
BackupIn label, include_metrics
Body_third_party_import_api_v1_admin_third_party_import_post file, dry_run, idempotent, collector_id
Body_upload_backup_api_v1_admin_backups_upload_post file
BreakdownIn metric, by, start, end, points
ChannelIn name, kind, config, secrets, enabled
CollectorIn name, site, transport, tenant_id
CredentialIn name, kind, username, password, token, private_key, passphrase, snmp, description, tenant_id
DashboardIn name, description, shared, time_range, folder, widgets
Decision approve, comment
DeployCollectorIn host, ssh_user, credential_id, transport
DeviceIn name, plugin, addresses, port, credential_id, collector_id, tenant_id, options, tags, enabled, verify_tls, perf_interval_s, inventory_interval_s, pinned
DirTestIn username
DirectoryIn name, kind, hosts, port, security, verify_tls, ca_cert, base_dn, bind_dn, bind_password, user_filter, username_attr, display_name_attr, email_attr, group_attr, nested_groups, group_role_map, default_role_id, auto_provision, enabled, priority, timeout_s
DiscoveryIn collector_id, targets, profile, ports, rate, concurrency
EntityMetricsIn metrics, start, end, agg
FindingUpdate status, assignee, note
FinishIn status, rc, error, text, result
GenerateIn topic, period, instructions
GroupMap group_dn, role_id, tenant_id
ImportIn devices
JobIn playbook_id, finding_id, target_entity_id, params
LicenseIn key
LogIn text, progress, step, result
LoginIn username, password, directory_id
LogoIn data_base64
NextIn hostname
OperationIn kind, params, secrets
OrgIn instance_name, base_url, timezone, language
OverrideIn scope, entity_id, device_id, entity_type, metric, warning, critical, disabled, note
PasswordIn current_password, new_password
PlaybookPatch enabled, requires_approval
PrefsIn preferences
ProfileIn name, fmt, signature, mapping
ProgressIn total, scanned, responding, identified, elapsed_s
QueryIn entity_type, metric, mode, agg, entity_ids, start, end, limit, order, step, buckets, with_names
RefreshIn refresh_token
RestoreIn confirm, force_key
RoleAssign role_id, tenant_id
RoleIn name, description, permissions
Rule entity_type, field, attr, op, value
RuleIn name, min_severity, categories, entity_types, channel_ids, playbook_id, enabled
SettingsPatch values
SetupDirectoryIn name, kind, hosts, port, security, verify_tls, ca_cert, base_dn, bind_dn, bind_password, admin_group, operator_group, analyst_group, viewer_group, default_role, test_username
SizingIn assets, ai
SmtpIn host, port, username, password, starttls, sender, test_to
StatusIn device_id, kind, ok, ts, duration_ms, rows, error, device_info
TargetIn name, type, config, secrets, enabled, encrypt, retention_keep, retention_days
TaskResult status, result
TenantIn name, slug, description, timezone
TestEmailIn to
TestIn device, from_server
TlsIn certificate, private_key, pfx_base64, passphrase, apply
TokenIn name, expires_days
TokenOut access_token, refresh_token, token_type, expires_in, must_change_password
UserIn username, display_name, email, password, is_active, is_superadmin, must_change_password, roles
UserUpdate display_name, email, password, is_active, is_superadmin, must_change_password, roles, unlock
Widget id, type, title, x, y, w, h, query, options
quantix__api__routers__devices__HeartbeatIn version, hostname, platform, devices, plugins, stats
quantix__api__routers__platform__HeartbeatIn hostname, agent_version, install_dir, current_version, disk_free_bytes, current_operation, info