VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Backups

Backups do banco e das mídias da loja: agendamento noturno, backup manual, download e restauração.

Backup é a cópia de segurança do banco de dados da loja e das mídias enviadas (imagens, arquivos). A plataforma faz uma cópia automática por noite e o administrador pode pedir outras quando quiser, baixar os arquivos para guardar fora da plataforma e restaurar a loja a partir de uma cópia.

Pontos principais
  • Backup e restauração são assíncronos: a chamada devolve 202 e você consulta o status.
  • Todas as rotas exigem o privilégio manage_backups (ou manage_settings).
  • Restaurar substitui o banco inteiro; o que foi gravado depois do backup se perde.
  • Os arquivos antigos são removidos por uma rotina de retenção e o registro passa a expired.

Como funciona

Um backup nasce pending, vira running enquanto o arquivo é gerado e termina completed (ou failed). Ao restaurar, o registro passa por restoring e termina restored (ou failed).

pending→running→completed→restoring→restored
StatusSignificado
pendingRegistrado, ainda não começou.
runningGerando o arquivo do banco e o pacote de mídias.
completedPronto: pode ser baixado e restaurado.
failedFalhou (veja error_msg). Também é o estado de um backup cuja restauração falhou.
restoringRestauração em andamento; a loja está em manutenção.
restoredJá foi usado em uma restauração; continua baixável e restaurável.
expiredO arquivo foi removido pela retenção; só o registro resta. Baixar ou restaurar dá 410.

Conceitos principais

Banco e mídias são arquivos separados

O arquivo do banco (.sql.gz) sempre existe em um backup concluído. O pacote de mídias (.tar.gz) é opcional: confira media_file_size antes de baixar.

Retenção

Uma rotina diária apaga do disco os arquivos mais antigos que o período de retenção da instalação (7 dias por padrão) e marca o registro como expired. O arquivo mais novo de cada tipo (banco e mídias) nunca é apagado, mesmo vencido.

Agendador

O backup noturno (por padrão às 03:00) é configuração da instalação. Use Estado do agendador para ver o horário, a próxima execução e se há erro na expressão.

Endpoints

MétodoCaminhoPara que servePágina
GET/api/v1/admin/backupsLista os backups, do mais novo ao mais antigoCriar e consultar backups
POST/api/v1/admin/backupsPede um backup manual (assíncrono)Criar e consultar backups
GET/api/v1/admin/backups/{id}Consulta um backup (para acompanhar o andamento)Criar e consultar backups
GET/api/v1/admin/backups/scheduler/statusEstado do agendador de backups noturnosCriar e consultar backups
GET/api/v1/admin/backups/{id}/downloadBaixa o arquivo do banco (.sql.gz)Baixar backups
GET/api/v1/admin/backups/{id}/download-mediaBaixa o pacote de mídias (.tar.gz)Baixar backups
POST/api/v1/admin/backups/{id}/restoreRestaura o banco (e opcionalmente as mídias) a partir de um backupRestaurar e excluir
DELETE/api/v1/admin/backups/{id}Exclui um backup e o arquivo deleRestaurar e excluir

Erros comuns

  • Esperar que POST /admin/backups já devolva o arquivo pronto: ele devolve 202 e pending.
  • Enviar POST /admin/backups sem corpo: o corpo precisa ser um JSON ({} serve).
  • Restaurar sem antes criar um backup do estado atual.
  • Tentar baixar um backup pending ou running: dá 400.
  • Ignorar o status failed de backups noturnos: o campo error_msg diz o motivo e vale monitorar.
  • Confiar em um backup expired: o registro existe, mas o arquivo não.

Próximos passos

Criar e consultar backups
Peça um backup e acompanhe.
Baixar backups
Guarde uma cópia fora da plataforma.
Restaurar e excluir
Recuperação de desastre.
Anterior
Avaliações de módulos
Próxima
Criar e consultar backups
Nesta página
  • Como funciona
  • Conceitos principais
  • Banco e mídias são arquivos separados
  • Retenção
  • Agendador
  • Endpoints
  • Erros comuns
  • Próximos passos