VPS.org API

REST API דאָקומענטאַציע

באַקאַפּס API

פאַרוואַלטן סערווער באַקאַפּס פּראָגראַמאַטיש. ליסטירן, שאַפֿן, צוריקשטעלן און ויסמעקן באַקאַפּס פֿאַר אייערע סערווערס.

ענדפּונקטן 3 endpoints
באַזע דרך /api/v1/backups
באַקומען /api/v1/backups/

ליסט אַלע באַקאַפּס

באַקומט אַ רשימה פֿון אַלע באַקאַפּס אויף אייערע סערווערס.

קווערי פּאַראַמעטערס

פּאַראַמעטער טיפּ פארלאנגט באַשרייַבונג
server_id integer ניין פילטער באַקאַפּס לויט סערווער ID
backup_type string ניין פילטערן לויט טיפ: manual , automatic

בייַשפּיל בקשה

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

בייַשפּיל ענטפער

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

ענטפער סטאַטוס קאָדעס

200 ערפאלגרייך צוריקגעכאפט באַקאַפּ רשימה
401 נישט בארעכטיגט - אומגילטיקער אדער פעלנדיקער אויטענטיפיקאציע טאָקען
פּאָסט /api/v1/backups/

שאַפֿן מאַנועלע באַקאַפּ

שאַפֿן אַ מאַנועלע באַקאַפּ פֿון אַ סערווער. מאַנועלע באַקאַפּס עקספּירירן נישט אויטאָמאַטיש.

פארלאנג גוף פאראמעטערס

פּאַראַמעטער טיפּ פארלאנגט באַשרייַבונג
server_id integer יא אידענטיפיקאציע פון סערווער צו באַקאַפּן
description string ניין אפציאנעלע באַשרייַבונג פֿאַר די באַקאַפּ

בייַשפּיל בקשה

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

בייַשפּיל ענטפער

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

ענטפער סטאַטוס קאָדעס

201 באַקאַפּ שאַפונג האָט זיך געלאָקט
400 שלעכטע פארלאנג - אומגילטיגע פאראמעטערס אדער אומרעכטע פארלאנג
401 נישט בארעכטיגט - אומגילטיקער אדער פעלנדיקער אויטענטיפיקאציע טאָקען
404 נישט געפֿונען - סערווער עקזיסטירט נישט
באַמערקונג: איר קענט האבן א מאקסימום פון 10 מאנועלע בעקאפס פער סערווער. אויטאמאטישע בעקאפס ווערן געהאלטן באזירט אויף אייער פלאן'ס בעקאפ אויפהאלטונג פאליסי (געווענליך 7-30 טעג).
אויסמעקן /api/v1/backups/{backup_id}/

אויסמעקן באַקאַפּ

אויסמעקן א באַקאַפּ אויף אייביק. די אַקציע קען נישט צוריקגעבראַכט ווערן.

וועג פּאַראַמעטערס

פּאַראַמעטער טיפּ פארלאנגט באַשרייַבונג
backup_id integer יא איינציקאַרטיקע באַקאַפּ ID

בייַשפּיל בקשה

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

ענטפער סטאַטוס קאָדעס

204 באַקאַפּ געראָטן אויסגעמעקט
401 נישט בארעכטיגט - אומגילטיקער אדער פעלנדיקער אויטענטיפיקאציע טאָקען
404 נישט געפֿונען - באַקאַפּ עקזיסטירט נישט
ווארענונג: אויסמעקן א באַקאַפּ איז שטענדיק און קען נישט צוריקגעמאַכט ווערן. מאַכט זיכער אַז איר דאַרפט מער נישט דעם באַקאַפּ איידער איר עס אויסמעקט.

צוריקשטעלן פון באַקאַפּס

צו צוריקשטעלן א סערווער פון א בעקאפ, ניצט דעם סערווערס API צוריקשטעלן ענדפונקט:

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

פֿאַר דעטאַלירטע אינפֿאָרמאַציע וועגן סערווער רעסטאָראַציע, זעט די סערווערס API דאָקומענטאַציע.

בעסטע פּראַקטיקעס פֿאַר באַקאַפּ