VPS.org API

Dukumentiyada REST API

Kaydinta API

Maamul kaydinta server-ka si barnaamij ah. Liis garee, samee, soo celi, oo tirtir kaydka server-yadaada.

Dhammaadka 3 endpoints
Waddo Saldhig ah /api/v1/backups
HEL /api/v1/backups/

Liis garee Dhammaan Kaydka

Soo qaado liiska dhammaan kaydinta xogta ee adeegayaashaada.

Cabbirrada Weydiinta

Halbeegga Nooca Loo baahan yahay Sharaxaad
server_id integer Maya Ku shaandhee kaydka aqoonsiga server-ka
backup_type string Maya Shaandhee nooca: manual , automatic

Codsi Tusaale ah

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

Jawaabta Tusaale

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

Koodhadhka Xaaladda Jawaab celinta

200 Si guul leh ayaa loo soo ceshaday liiska kaydinta
401 Aan la ogolayn - Calaamadda xaqiijinta oo aan sax ahayn ama maqan
BOOSKA /api/v1/backups/

Samee Kaydinta Gacanta ah

Samee kayd gacan ah oo server ah. Kaydinta gacanta si toos ah uma dhacdo.

Codso Cabbirrada Jirka

Halbeegga Nooca Loo baahan yahay Sharaxaad
server_id integer Haa Aqoonsiga server-ka si loo kaydiyo
description string Maya Sharaxaad ikhtiyaari ah oo loogu talagalay kaydinta

Codsi Tusaale ah

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

Jawaabta Tusaale

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

Koodhadhka Xaaladda Jawaab celinta

201 Abuuritaanka kaydinta ayaa si guul leh loo bilaabay
400 Codsi Xun - Xuduudo aan sax ahayn ama codsi khaldan
401 Aan la ogolayn - Calaamadda xaqiijinta oo aan sax ahayn ama maqan
404 Lama helin - Server ma jiro
Fiiro gaar ah: Waxaad heli kartaa ugu badnaan 10 kayd oo gacan ah halkii server. Kaydinta otomaatiga ah waxaa lagu hayaa iyadoo lagu saleynayo siyaasadda kaydinta kaydka ee qorshahaaga (badanaa 7-30 maalmood).
TIRTIR /api/v1/backups/{backup_id}/

Tirtir Kaydka

Si joogto ah u tirtir keyd. Tallaabadan lama celin karo.

Halbeegyada Wadada

Halbeegga Nooca Loo baahan yahay Sharaxaad
backup_id integer Haa Aqoonsi kayd ah oo gaar ah

Codsi Tusaale ah

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

Koodhadhka Xaaladda Jawaab celinta

204 Kaydka kaydinta si guul leh ayaa loo tirtiray
401 Aan la ogolayn - Calaamadda xaqiijinta oo aan sax ahayn ama maqan
404 Lama helin - Kaydinta ma jirto
Digniin: Tirtiridda kaydinta waa mid joogto ah oo aan dib loo celin karin. Hubi inaadan u baahnayn kaydintan ka hor intaadan tirtirin.

Soo celinta Kaydka

Si aad server uga soo celiso kayd, isticmaal dhammaadka soo celinta Servers API :

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

Wixii macluumaad faahfaahsan oo ku saabsan soo celinta server-ka, fiiri Dukumentiyada API ee Adeegayaasha.

Dhaqamada ugu Fiican ee Kaydinta