VPS.org API

Dokumentasyon ng REST API

Mga Backup API

Pamahalaan ang mga backup ng server sa pamamagitan ng programa. Ilista, lumikha, magbalik, at magtanggal ng mga backup para sa iyong mga server.

Mga Endpoint 3 endpoints
Landas ng Batayan /api/v1/backups
KUMUHA /api/v1/backups/

Ilista ang Lahat ng Backup

Kumuha ng listahan ng lahat ng backup sa iyong mga server.

Mga Parameter ng Query

Parametro Uri Kinakailangan Paglalarawan
server_id integer Hindi I-filter ang mga backup ayon sa server ID
backup_type string Hindi Salain ayon sa uri: manual , automatic

Halimbawang Kahilingan

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

Halimbawang Tugon

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

Mga Kodigo ng Katayuan ng Tugon

200 Matagumpay na nakuha ang listahan ng backup
401 Hindi Awtorisado - Hindi wasto o nawawalang token ng pagpapatotoo
POST /api/v1/backups/

Gumawa ng Manu-manong Pag-backup

Gumawa ng manu-manong backup ng isang server. Ang mga manu-manong backup ay hindi awtomatikong mawawalan ng bisa.

Humiling ng mga Parameter ng Katawan

Parametro Uri Kinakailangan Paglalarawan
server_id integer Oo ID ng server na iba-backup
description string Hindi Opsyonal na paglalarawan para sa backup

Halimbawang Kahilingan

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

Halimbawang Tugon

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

Mga Kodigo ng Katayuan ng Tugon

201 Matagumpay na nasimulan ang paggawa ng backup
400 Masamang Kahilingan - Hindi wastong mga parameter o maling anyo ng kahilingan
401 Hindi Awtorisado - Hindi wasto o nawawalang token ng pagpapatotoo
404 Hindi Natagpuan - Walang server
Paalala: Maaari kang magkaroon ng maximum na 10 manu-manong backup bawat server. Ang mga awtomatikong backup ay pinapanatili batay sa patakaran sa pagpapanatili ng backup ng iyong plano (karaniwan ay 7-30 araw).
TANGGALIN /api/v1/backups/{backup_id}/

Burahin ang Backup

Permanenteng burahin ang isang backup. Hindi na maaaring bawiin ang aksyon na ito.

Mga Parameter ng Landas

Parametro Uri Kinakailangan Paglalarawan
backup_id integer Oo Natatanging ID ng backup

Halimbawang Kahilingan

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

Mga Kodigo ng Katayuan ng Tugon

204 Matagumpay na nabura ang backup
401 Hindi Awtorisado - Hindi wasto o nawawalang token ng pagpapatotoo
404 Hindi Natagpuan - Walang backup
Babala: Permanente ang pagbura ng backup at hindi na maaaring i-undo. Siguraduhing hindi mo na kailangan ang backup na ito bago ito burahin.

Pagpapanumbalik mula sa mga Backup

Para ibalik ang isang server mula sa isang backup, gamitin ang Servers API restore endpoint:

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

Para sa detalyadong impormasyon tungkol sa pagpapanumbalik ng server, tingnan ang Dokumentasyon ng API ng mga Server.

Mga Pinakamahusay na Kasanayan sa Pag-backup