VPS.org API

Dokumentacja interfejsu API REST

API kopii zapasowych

Zarządzaj programowo kopiami zapasowymi serwerów. Wyświetlaj, twórz, przywracaj i usuwaj kopie zapasowe swoich serwerów.

Punkty końcowe 3 endpoints
Ścieżka bazowa /api/v1/backups
DOSTAWAĆ /api/v1/backups/

Wyświetl wszystkie kopie zapasowe

Pobierz listę wszystkich kopii zapasowych na swoich serwerach.

Parametry zapytania

Parametr Typ Wymagany Opis
server_id integer NIE Filtruj kopie zapasowe według identyfikatora serwera
backup_type string NIE Filtruj według typu: manual , automatic

Przykładowe żądanie

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);

Przykładowa odpowiedź

{
  "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"
    }
  ]
}

Kody statusu odpowiedzi

200 Pomyślnie pobrano listę kopii zapasowych
401 Nieautoryzowany – nieprawidłowy lub brakujący token uwierzytelniający
POST /api/v1/backups/

Utwórz kopię zapasową ręczną

Utwórz ręczną kopię zapasową serwera. Ręczne kopie zapasowe nie wygasają automatycznie.

Parametry treści żądania

Parametr Typ Wymagany Opis
server_id integer Tak ID serwera do utworzenia kopii zapasowej
description string NIE Opcjonalny opis kopii zapasowej

Przykładowe żądanie

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);

Przykładowa odpowiedź

{
  "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."
}

Kody statusu odpowiedzi

201 Tworzenie kopii zapasowej zostało pomyślnie zainicjowane
400 Błędne żądanie – nieprawidłowe parametry lub błędnie sformatowane żądanie
401 Nieautoryzowany – nieprawidłowy lub brakujący token uwierzytelniający
404 Nie znaleziono — serwer nie istnieje
Notatka: Możesz utworzyć maksymalnie 10 ręcznych kopii zapasowych na serwer. Kopie automatyczne są przechowywane zgodnie z polityką przechowywania kopii zapasowych Twojego planu (zwykle 7–30 dni).
USUWAĆ /api/v1/backups/{backup_id}/

Usuń kopię zapasową

Trwale usuń kopię zapasową. Tej czynności nie można cofnąć.

Parametry ścieżki

Parametr Typ Wymagany Opis
backup_id integer Tak Unikalny identyfikator kopii zapasowej

Przykładowe żądanie

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);

Kody statusu odpowiedzi

204 Kopia zapasowa została pomyślnie usunięta
401 Nieautoryzowany – nieprawidłowy lub brakujący token uwierzytelniający
404 Nie znaleziono — kopia zapasowa nie istnieje
Ostrzeżenie: Usunięcie kopii zapasowej jest trwałe i nie można go cofnąć. Przed usunięciem upewnij się, że nie potrzebujesz już tej kopii zapasowej.

Przywracanie z kopii zapasowych

Aby przywrócić serwer z kopii zapasowej, należy skorzystać z punktu końcowego przywracania interfejsu API serwerów :

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

Aby uzyskać szczegółowe informacje na temat przywracania serwera, zobacz Dokumentacja API serwerów.

Najlepsze praktyki tworzenia kopii zapasowych