VPS.org API

REST API-documentatie

Backups API

Beheer serverbackups programmatisch. Bekijk, maak, herstel en verwijder back-ups voor uw servers.

Eindpunten 3 endpoints
Basispad /api/v1/backups
KRIJGEN /api/v1/backups/

Alle back-ups weergeven

Vraag een lijst op van alle back-ups op uw servers.

Queryparameters

Parameter Type Vereist Beschrijving
server_id integer Nee Filter back-ups op server-ID
backup_type string Nee Filteren op type: manual , automatic

Voorbeeldverzoek

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

Voorbeeldantwoord

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

Responsstatuscodes

200 Back-uplijst succesvol opgehaald
401 Niet geautoriseerd - Ongeldig of ontbrekend authenticatietoken
NA /api/v1/backups/

Handmatige back-up maken

Maak een handmatige back-up van een server. Handmatige back-ups verlopen niet automatisch.

Parameters van de aanvraagbody

Parameter Type Vereist Beschrijving
server_id integer Ja ID van de server waarvan een back-up moet worden gemaakt
description string Nee Optionele beschrijving voor de back-up

Voorbeeldverzoek

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

Voorbeeldantwoord

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

Responsstatuscodes

201 Het aanmaken van de back-up is succesvol gestart.
400 Ongeldig verzoek - Ongeldige parameters of een onjuist geformuleerd verzoek.
401 Niet geautoriseerd - Ongeldig of ontbrekend authenticatietoken
404 Niet gevonden - Server bestaat niet
Opmerking: U kunt maximaal 10 handmatige back-ups per server maken. Automatische back-ups worden bewaard volgens het back-upbewaarbeleid van uw abonnement (doorgaans 7-30 dagen).
VERWIJDEREN /api/v1/backups/{backup_id}/

Back-up verwijderen

Een back-up permanent verwijderen. Deze actie kan niet ongedaan worden gemaakt.

Padparameters

Parameter Type Vereist Beschrijving
backup_id integer Ja Unieke back-up-ID

Voorbeeldverzoek

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

Responsstatuscodes

204 Back-up succesvol verwijderd
401 Niet geautoriseerd - Ongeldig of ontbrekend authenticatietoken
404 Niet gevonden - Back-up bestaat niet
Waarschuwing: Het verwijderen van een back-up is permanent en kan niet ongedaan worden gemaakt. Zorg ervoor dat u deze back-up niet meer nodig hebt voordat u deze verwijdert.

Herstellen vanuit back-ups

Om een server vanuit een back-up te herstellen, gebruikt u het herstel-eindpunt van de Servers API :

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

Voor gedetailleerde informatie over het herstellen van servers, zie de API-documentatie voor servers.

Beste praktijken voor back-ups