VPS.org API

REST API dokumentatsioon

Varunduste API

Serveri varukoopiate haldamine programmiliselt. Loetlege, looge, taastage ja kustutage oma serverite varukoopiaid.

Lõpp-punktid 3 endpoints
Baasrada /api/v1/backups
SAA /api/v1/backups/

Loetle kõik varukoopiad

Hankige nimekiri kõigist teie serverites olevatest varukoopiatest.

Päringuparameetrid

Parameeter Tüüp Nõutav Kirjeldus
server_id integer Ei Filtreeri varukoopiaid serveri ID järgi
backup_type string Ei Filtreeri tüübi järgi: manual , automatic

Näidistaotlus

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

Näidisvastus

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

Vastuse olekukoodid

200 Varukoopiate loend on edukalt alla laaditud
401 Volitamata – sobimatu või puuduv autentimistunnus
POST /api/v1/backups/

Loo käsitsi varukoopia

Loo serverist käsitsi varukoopia. Käsitsi tehtud varukoopiad ei aegu automaatselt.

Taotluse sisu parameetrid

Parameeter Tüüp Nõutav Kirjeldus
server_id integer Jah Varundatava serveri ID
description string Ei Varukoopia valikuline kirjeldus

Näidistaotlus

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

Näidisvastus

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

Vastuse olekukoodid

201 Varukoopia loomine edukalt algatatud
400 Vigane päring – sobimatud parameetrid või valesti vormindatud päring
401 Volitamata – sobimatu või puuduv autentimistunnus
404 Ei leitud – serverit pole olemas
Märkus: Serveri kohta saab teha maksimaalselt 10 käsitsi varukoopiat. Automaatseid varukoopiaid säilitatakse teie paketi varukoopiate säilituspoliitika alusel (tavaliselt 7–30 päeva).
KUSTUTA /api/v1/backups/{backup_id}/

Kustuta varukoopia

Varukoopia jäädavalt kustutamine. Seda toimingut ei saa tagasi võtta.

Tee parameetrid

Parameeter Tüüp Nõutav Kirjeldus
backup_id integer Jah Unikaalne varundus-ID

Näidistaotlus

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

Vastuse olekukoodid

204 Varukoopia kustutati edukalt
401 Volitamata – sobimatu või puuduv autentimistunnus
404 Ei leitud – varukoopiat pole olemas
Hoiatus: Varukoopia kustutamine on jäädav ja seda ei saa tagasi võtta. Enne kustutamist veenduge, et te seda varukoopiat enam ei vaja.

Varukoopiatest taastamine

Serveri varukoopiast taastamiseks kasutage serverite API taastepunkti:

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

Serveri taastamise kohta leiate üksikasjalikku teavet aadressilt Serverite API dokumentatsioon.

Varundamise parimad tavad