Pular para o conteúdo principal

Lista de Endpoints da API

Este documento fornece uma tabela de referência rápida de todos os endpoints da API disponíveis (em ordem alfabética de endpoint).

EndpointMétodoDescriçãoGrupo
/api/audit-logGETListar Logs de AuditoriaAdministração
/api/audit-log/cleanupPOSTLimpar Logs de AuditoriaAdministração
/api/audit-log/downloadGETBaixar Logs de AuditoriaAdministração
/api/audit-log/filtersGETObter Valores de Filtro de Log de AuditoriaAdministração
/api/audit-log/retentionGETObter Retenção de Log de AuditoriaAdministração
/api/audit-log/retentionPATCHAtualizar Retenção de Log de AuditoriaAdministração
/api/api-keysGETListar Chaves de APIAdministração
/api/api-keysPOSTCriar chave de APIAdministração
/api/api-keys/:idPATCHAtualizar Chave de APIAdministração
/api/api-keys/:idDELETEExcluir chave de APIAdministração
/api/application-logsGETObter Logs do AplicativoAdministração
/api/application-logs/exportGETExportar Logs do AplicativoAdministração
/api/database/backupGETFazer Backup do Banco de DadosAdministração
/api/database/restorePOSTRestaurar Banco de DadosAdministração
/api/auth/admin-must-change-passwordGETVerificar se Administrador Deve Alterar SenhaAutenticação e Segurança
/api/auth/change-passwordPOSTAlterar SenhaAutenticação e Segurança
/api/auth/loginPOSTLoginAutenticação e Segurança
/api/auth/logoutPOSTLogoutAutenticação e Segurança
/api/auth/meGETObter Usuário AtualAutenticação e Segurança
/api/auth/password-policyGETObter Política de SenhasAutenticação e Segurança
/api/backups/cleanupPOSTLimpar BackupsAdministração
/api/backups/collectPOSTColetar BackupsAdministração
/api/backups/delete-jobDELETEExcluir Tarefa de BackupAdministração
/api/backups/last-timestampsGETObter Carimbos de Data/Hora do Último BackupAdministração
/api/backups/sync-schedulePOSTSincronizar Agendamentos de BackupAdministração
/api/chart-data/aggregatedGETObter Dados Agregados do GráficoDados do Gráfico
/api/chart-data/server/:serverIdGETObter Dados do Gráfico do ServidorDados do Gráfico
/api/chart-data/server/:serverId/backup/:backupNameGETObter Dados do Gráfico de Backup do ServidorDados do Gráfico
/api/configuration/backup-settingsPOSTAtualizar Configurações de BackupGerenciamento de Configuração
/api/configuration/external-api-securityGETObter Segurança da API ExternaGerenciamento de Configuração
/api/configuration/external-api-securityPATCHAtualizar Segurança da API ExternaGerenciamento de Configuração
/api/configuration/ip-allowlistGETObter Lista de permissões de IPGerenciamento de Configuração
/api/configuration/ip-allowlistPATCHAtualizar Lista de permissões de IPGerenciamento de Configuração
/api/configuration/daily-summaryGETObter Status do Resumo DiárioGerenciamento de Configuração
/api/configuration/daily-summaryPOSTAtualizar Resumo DiárioGerenciamento de Configuração
/api/configuration/daily-summary/previewPOSTVisualização do Resumo DiárioGerenciamento de Configuração
/api/configuration/daily-summary/retryPOSTTentar Novamente o Resumo DiárioGerenciamento de Configuração
/api/configuration/daily-summary/sendPOSTEnviar Resumo Diário AgoraGerenciamento de Configuração
/api/configuration/emailDELETEExcluir configuração de e-mailGerenciamento de configuração
/api/configuration/emailGETObter configuração de e-mailGerenciamento de configuração
/api/configuration/emailPOSTAtualizar configuração de e-mailGerenciamento de configuração
/api/configuration/email/passwordGETObter token CSRF da senha de e-mailGerenciamento de configuração
/api/configuration/email/passwordPATCHAtualizar senha de e-mailGerenciamento de configuração
/api/configuration/notificationsGETObter configuração de notificaçõesGerenciamento de configuração
/api/configuration/notificationsPOSTAtualizar configuração de notificaçõesGerenciamento de configuração
/api/configuration/ntfyGETObter Configuração do NTFYGerenciamento de configuração
/api/configuration/overdue-toleranceGETObter tolerância de atrasadoGerenciamento de configuração
/api/configuration/overdue-tolerancePOSTAtualizar tolerância de atrasadoGerenciamento de configuração
/api/configuration/templatesPOSTAtualizar Modelos de notificaçãoGerenciamento de configuração
/api/configuration/unifiedGETObter configuração unificadaGerenciamento de configuração
/api/cron-configGETObter configuração do CronServiços do Cron
/api/cron-configPOSTAtualizar configuração do CronServiços do Cron
/api/cron/*GETProxy do serviço CronServiços do Cron
/api/cron/*POSTProxy do serviço CronServiços do Cron
/api/csrfGETObter token CSRFGerenciamento de sessão
/api/dashboardGETObter dados do painel (consolidados)Operações principais
/api/detail/:serverIdGETObter dados do Servidor com informações de AtrasadoOperações principais
/api/healthGETVerificar integridadeMonitoramento e integridade
/api/pingGETSonda de conectividadeMonitoramento e integridade
/api/lastbackup/:serverIdGETObter backup mais recenteAPIs externas
/api/lastbackups/:serverIdGETObter backups mais recentesAPIs externas
/api/notification-channel-alertsGETListar Alertas do Canal de NotificaçãoSistema de Notificações
/api/notification-channel-alertsPOSTLimpar Alertas do Canal de NotificaçãoSistema de Notificações
/api/notifications/check-overduePOSTVerificar Backups AtrasadosSistema de notificação
/api/notifications/clear-overdue-timestampsPOSTLimpar carimbos de data/hora atrasadosSistema de notificação
/api/notifications/previewPOSTVisualização de modelo de notificaçãoSistema de notificação
/api/notifications/testPOSTTestar notificaçãoSistema de notificação
/api/serversGETObter todos os servidoresOperações principais
/api/servers/:idDELETEExcluir ServidorOperações principais
/api/servers/:idGETObter detalhes do servidorOperações principais
/api/servers/:idPATCHAtualizar servidorOperações principais
/api/servers/duplicatesGETObter Servidores DuplicadosOperações principais
/api/servers/mergePOSTMesclar ServidoresOperações principais
/api/servers/:serverId/passwordGETObter senha do servidorAdministração
/api/servers/:serverId/passwordPATCHAtualizar senha do servidorAdministração
/api/servers/:serverId/server-urlGETObter URL do servidorAdministração
/api/servers/:serverId/server-urlPATCHAtualizar URL do servidorAdministração
/api/servers/test-connectionPOSTTestar conexão do servidorAdministração
/api/sessionPOSTCriar sessãoGerenciamento de sessão
/api/sessionDELETEExcluir sessãoGerenciamento de sessão
/api/sessionGETValidar sessãoGerenciamento de sessão
/api/summaryGETObter resumo geralAPIs externas
/api/uploadPOSTCarregar dados de backupAPIs externas
/api/usersGETListar usuáriosAdministração
/api/usersPOSTCriar UsuárioAdministração
/api/users/:idPATCHAtualizar UsuárioAdministração
/api/users/:idDELETEExcluir UsuárioAdministração