VPS.org API

Documentação da API REST

API de backups

Gerencie backups de servidores programaticamente. Liste, crie, restaure e exclua backups de seus servidores.

Pontos finais 3 endpoints
Caminho base /api/v1/backups
PEGAR /api/v1/backups/

Listar todos os backups

Obtenha uma lista de todos os backups em seus servidores.

Parâmetros de consulta

Parâmetro Tipo Obrigatório Descrição
server_id integer Não Filtrar backups por ID do servidor
backup_type string Não Filtrar por tipo: manual , automatic

Exemplo de solicitação

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/backups/?server_id=12345" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
params = {"server_id": 12345}

response = requests.get(url, headers=headers, params=params)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/backups/?server_id=12345', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const backups = await response.json();
console.log(backups);

Exemplo de resposta

{
  "count": 3,
  "results": [
    {
      "id": 501,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "automatic",
      "status": "completed",
      "size_mb": 4523,
      "created_at": "2025-01-16T03:00:00Z",
      "expires_at": "2025-02-16T03:00:00Z",
      "description": "Automatic daily backup"
    },
    {
      "id": 499,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "manual",
      "status": "completed",
      "size_mb": 4456,
      "created_at": "2025-01-14T10:30:00Z",
      "expires_at": null,
      "description": "Pre-update backup"
    },
    {
      "id": 495,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "backup_type": "automatic",
      "status": "completed",
      "size_mb": 4389,
      "created_at": "2025-01-15T03:00:00Z",
      "expires_at": "2025-02-15T03:00:00Z",
      "description": "Automatic daily backup"
    }
  ]
}

Códigos de status de resposta

200 Lista de backup recuperada com sucesso
401 Não autorizado - Token de autenticação inválido ou ausente
PUBLICAR /api/v1/backups/

Criar backup manual

Crie um backup manual de um servidor. Os backups manuais não expiram automaticamente.

Parâmetros do corpo da requisição

Parâmetro Tipo Obrigatório Descrição
server_id integer Sim ID do servidor para backup
description string Não Descrição opcional para o backup

Exemplo de solicitação

cURL
Python
JavaScript
PHP
curl -X POST "https://admin.vps.org/api/v1/backups/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "server_id": 12345,
    "description": "Pre-deployment backup"
  }'
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "server_id": 12345,
    "description": "Pre-deployment backup"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    server_id: 12345,
    description: 'Pre-deployment backup'
  })
});

const backup = await response.json();
console.log(backup);
$data = [
    'server_id' => 12345,
    'description' => 'Pre-deployment backup'
];

$ch = curl_init('https://admin.vps.org/api/v1/backups/');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$backup = json_decode($response, true);
curl_close($ch);

Exemplo de resposta

{
  "id": 502,
  "server": {
    "id": 12345,
    "name": "web-server-01"
  },
  "backup_type": "manual",
  "status": "in_progress",
  "size_mb": null,
  "created_at": "2025-01-16T15:45:00Z",
  "expires_at": null,
  "description": "Pre-deployment backup",
  "message": "Backup is being created. This may take several minutes depending on server size."
}

Códigos de status de resposta

201 Criação do backup iniciada com sucesso
400 Solicitação inválida - Parâmetros inválidos ou solicitação malformada
401 Não autorizado - Token de autenticação inválido ou ausente
404 Não encontrado - O servidor não existe.
Observação: Você pode ter no máximo 10 backups manuais por servidor. Os backups automáticos são retidos de acordo com a política de retenção de backups do seu plano (normalmente de 7 a 30 dias).
EXCLUIR /api/v1/backups/{backup_id}/

Excluir backup

Excluir permanentemente um backup. Esta ação não pode ser desfeita.

Parâmetros de caminho

Parâmetro Tipo Obrigatório Descrição
backup_id integer Sim ID de backup exclusivo

Exemplo de solicitação

cURL
Python
JavaScript
curl -X DELETE "https://admin.vps.org/api/v1/backups/501/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

backup_id = 501
url = f"https://admin.vps.org/api/v1/backups/{backup_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.delete(url, headers=headers)
print(response.status_code)
const backupId = 501;
const response = await fetch(`https://admin.vps.org/api/v1/backups/${backupId}/`, {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

console.log(response.status);

Códigos de status de resposta

204 Cópia de segurança excluída com sucesso
401 Não autorizado - Token de autenticação inválido ou ausente
404 Não encontrado - O backup não existe.
Aviso: A exclusão de um backup é permanente e não pode ser desfeita. Certifique-se de que não precisa mais desse backup antes de excluí-lo.

Restauração a partir de backups

Para restaurar um servidor a partir de um backup, use o endpoint de restauração da API de Servidores :

POST /api/v1/servers/{server_id}/restore/
{
  "backup_id": 501
}

Para obter informações detalhadas sobre a restauração do servidor, consulte o Documentação da API de servidores.

Melhores práticas de backup