VPS.org API

Dokuméntasi REST API

API Cadangan

Atur cadangan server sacara program. Daptar, jieun, mulangkeun, sareng hapus cadangan pikeun server anjeun.

Titik Tungtung 3 endpoints
Jalur Dasar /api/v1/backups
MEUNANGKEUN /api/v1/backups/

Daptarkeun Sadaya Cadangan

Candak daptar sadaya cadangan di sakumna server anjeun.

Parameter Pamundut

Parameter Tipe Diperlukeun Pedaran
server_id integer Henteu Saring cadangan dumasar ID server
backup_type string Henteu Saring dumasar kana jinisna: manual , automatic

Conto Pamundut

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

Conto Réspon

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

Kodeu Status Tanggapan

200 Daptar cadangan parantos hasil dicandak
401 Teu Sah - Token auténtikasi teu valid atanapi leungit
POSTING /api/v1/backups/

Jieun Cadangan Manual

Jieun cadangan server sacara manual. Cadangan manual henteu otomatis kadaluwarsa.

Pamundut Parameter Awak

Parameter Tipe Diperlukeun Pedaran
server_id integer Muhun ID server anu bade di-backup
description string Henteu Pedaran opsional pikeun cadangan

Conto Pamundut

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

Conto Réspon

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

Kodeu Status Tanggapan

201 Nyieun cadangan dimimitian kalawan suksés
400 Pamundut Goréng - Parameter teu valid atanapi pamundut anu salah format
401 Teu Sah - Token auténtikasi teu valid atanapi leungit
404 Teu Kapanggih - Server teu aya
Catetan: Anjeun tiasa gaduh maksimal 10 cadangan manual per server. Cadangan otomatis disimpen dumasar kana kawijakan panyimpenan cadangan rencana anjeun (biasana 7-30 dinten).
HAPUS /api/v1/backups/{backup_id}/

Hapus Cadangan

Hapus cadangan sacara permanén. Peta ieu teu tiasa dibolaykeun.

Parameter Jalur

Parameter Tipe Diperlukeun Pedaran
backup_id integer Muhun ID cadangan unik

Conto Pamundut

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

Kodeu Status Tanggapan

204 Cadangan parantos dihapus kalayan suksés
401 Teu Sah - Token auténtikasi teu valid atanapi leungit
404 Teu Kapanggih - Cadangan teu aya
Peringatan: Ngahapus cadangan téh permanén sareng teu tiasa dibolaykeun deui. Pastikeun anjeun teu peryogi deui cadangan ieu sateuacan ngahapusna.

Mulangkeun tina Cadangan

Pikeun mulangkeun server tina cadangan, anggo titik tungtung pamulihan Servers API :

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

Kanggo inpormasi lengkep ngeunaan pamulihan server, tingali Dokuméntasi API server.

Praktik Pangsaéna pikeun Cadangan