VPS.org API

Documentația API-ului REST

API-ul pentru copii de rezervă

Gestionați copiile de rezervă ale serverelor programatic. Enumerați, creați, restaurați și ștergeți copii de rezervă pentru serverele dvs.

Puncte finale 3 endpoints
Calea de bază /api/v1/backups
OBŢINE /api/v1/backups/

Listați toate copiile de rezervă

Obțineți o listă cu toate copiile de rezervă de pe serverele dvs.

Parametrii de interogare

Parametru Tip Necesar Descriere
server_id integer Nu Filtrarea copiilor de rezervă după ID-ul serverului
backup_type string Nu Filtrare după tip: manual , automatic

Exemplu de solicitare

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

Exemplu de răspuns

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

Coduri de stare a răspunsului

200 Lista de copii de rezervă recuperată cu succes
401 Neautorizat - Token de autentificare invalid sau lipsă
POST /api/v1/backups/

Creați o copie de rezervă manuală

Creați o copie de rezervă manuală a unui server. Copiile de rezervă manuale nu expiră automat.

Parametrii corpului cererii

Parametru Tip Necesar Descriere
server_id integer Da ID-ul serverului pentru backup
description string Nu Descriere opțională pentru copie de rezervă

Exemplu de solicitare

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

Exemplu de răspuns

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

Coduri de stare a răspunsului

201 Crearea copiei de rezervă a fost inițiată cu succes
400 Cerere greșită - Parametri invalidi sau cerere incorect formatată
401 Neautorizat - Token de autentificare invalid sau lipsă
404 Negăsit - Serverul nu există
Nota: Puteți avea maximum 10 copii de rezervă manuale per server. Copiile de rezervă automate sunt păstrate în funcție de politica de păstrare a copiilor de rezervă a planului dvs. (de obicei 7-30 de zile).
ŞTERGE /api/v1/backups/{backup_id}/

Ștergeți copia de rezervă

Ștergeți definitiv o copie de rezervă. Această acțiune nu poate fi anulată.

Parametrii căii

Parametru Tip Necesar Descriere
backup_id integer Da ID unic de rezervă

Exemplu de solicitare

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

Coduri de stare a răspunsului

204 Copia de rezervă a fost ștersă cu succes
401 Neautorizat - Token de autentificare invalid sau lipsă
404 Negăsit - Copia de rezervă nu există
Avertizare: Ștergerea unei copii de rezervă este permanentă și nu poate fi anulată. Asigurați-vă că nu mai aveți nevoie de această copie de rezervă înainte de a o șterge.

Restaurarea din copii de rezervă

Pentru a restaura un server dintr-o copie de rezervă, utilizați punctul final de restaurare al API-ului Servers :

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

Pentru informații detaliate despre restaurarea serverului, consultați Documentația API-ului serverelor.

Cele mai bune practici pentru backup