Backups

Acesso restrito a sessão de suporte. Não faz parte do escopo de integração via API key.

Base: https://api.nivesistemas.com.br · 12 endpoints

GET /database-backups

Listar backups

curl

curl -X GET "https://api.nivesistemas.com.br/database-backups" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/database-backups", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/database-backups",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /database-backups

Criar backup

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
name	string	não	Nome do backup

curl

curl -X POST "https://api.nivesistemas.com.br/database-backups" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"name":"Exemplo"}'

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/database-backups", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Exemplo"
  }),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/database-backups",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "name": "Exemplo"
    },
)
print(res.json())

PATCH /database-backups/:id

Renomear backup

Parâmetros de rota: id

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
name	string	sim	Novo nome

curl

curl -X PATCH "https://api.nivesistemas.com.br/database-backups/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"name":"Exemplo"}'

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/database-backups/{id}", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "Exemplo"
  }),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "PATCH",
    "https://api.nivesistemas.com.br/database-backups/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "name": "Exemplo"
    },
)
print(res.json())

GET /database-backups/:id/download

Baixar arquivo do backup (stream)

Parâmetros de rota: id

curl

curl -X GET "https://api.nivesistemas.com.br/database-backups/{id}/download" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/database-backups/{id}/download", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/database-backups/{id}/download",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /database-backups/restore-from-file

Enfileirar restauração a partir de arquivo enviado

Endpoint sensível

Trate credenciais e dados pessoais com cuidado: não registre o corpo nem a resposta em logs.

Corpo (JSON)

Campo	Tipo	Obrigatório	Descrição
(corpo binário)	application/octet-stream	não	Arquivo .sql, .dump, .db, .sqlite ou .enc. Cabeçalho X-Backup-Filename.

Resposta: Responde 202 e restaura em segundo plano. Cria backup automático do estado anterior. Acompanhe em GET /restore-jobs.

curl

curl -X POST "https://api.nivesistemas.com.br/database-backups/restore-from-file" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo" \
  -H "Content-Type: application/json" \
  -d '{"(corpo binário)":null}'

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/database-backups/restore-from-file", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "(corpo binário)": null
  }),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/database-backups/restore-from-file",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
    json={
      "(corpo binário)": None
    },
)
print(res.json())

POST /database-backups/:id/restore

Enfileirar restauração de um backup da lista

Endpoint sensível

Trate credenciais e dados pessoais com cuidado: não registre o corpo nem a resposta em logs.

Parâmetros de rota: id

Resposta: Responde 202 e restaura em segundo plano. Cria backup automático do estado anterior. Acompanhe em GET /restore-jobs.

curl

curl -X POST "https://api.nivesistemas.com.br/database-backups/{id}/restore" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/database-backups/{id}/restore", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/database-backups/{id}/restore",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /database-backups/jobs

Listar jobs de backup

curl

curl -X GET "https://api.nivesistemas.com.br/database-backups/jobs" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/database-backups/jobs", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/database-backups/jobs",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /database-backups/restore-jobs

Listar restaurações em andamento e recentes

curl

curl -X GET "https://api.nivesistemas.com.br/database-backups/restore-jobs" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/database-backups/restore-jobs", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/database-backups/restore-jobs",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

GET /database-backups/retention-policy

Política de retenção de backups

curl

curl -X GET "https://api.nivesistemas.com.br/database-backups/retention-policy" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/database-backups/retention-policy", {
  method: "GET",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.nivesistemas.com.br/database-backups/retention-policy",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /database-backups/bulk-delete

Excluir backups em lote

Endpoint sensível

Trate credenciais e dados pessoais com cuidado: não registre o corpo nem a resposta em logs.

curl

curl -X POST "https://api.nivesistemas.com.br/database-backups/bulk-delete" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/database-backups/bulk-delete", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/database-backups/bulk-delete",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

POST /database-backups/prune

Aplicar retenção e remover backups antigos

curl

curl -X POST "https://api.nivesistemas.com.br/database-backups/prune" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/database-backups/prune", {
  method: "POST",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://api.nivesistemas.com.br/database-backups/prune",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())

DELETE /database-backups/:id

Excluir backup

Endpoint sensível

Trate credenciais e dados pessoais com cuidado: não registre o corpo nem a resposta em logs.

Parâmetros de rota: id

Resposta: 204 No Content

curl

curl -X DELETE "https://api.nivesistemas.com.br/database-backups/{id}" \
  -H "Authorization: Bearer sl_live_exemplo_abc123xyz789" \
  -H "X-Store-Slug: loja-demo"

JavaScript

const res = await fetch("https://api.nivesistemas.com.br/database-backups/{id}", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer sl_live_exemplo_abc123xyz789",
    "X-Store-Slug": "loja-demo",
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "DELETE",
    "https://api.nivesistemas.com.br/database-backups/{id}",
    headers={
        "Authorization": "Bearer sl_live_exemplo_abc123xyz789",
        "X-Store-Slug": "loja-demo",
    },
)
print(res.json())