VPS.org API

REST API ਡੌਕੂਮੈਂਟੇਸ਼ਨ

ਬੈਕਅੱਪ API

ਆਪਣੇ ਸਰਵਰ ਬੈਕਅੱਪ ਦੀ ਲਿਸਟ ਬਣਾਓ, ਨਵਾਂ ਬੈਕਅੱਪ ਸ਼ੁਰੂ ਕਰੋ ਅਤੇ ਸਰਵਰ ਨੂੰ ਇੱਕ ਤੋਂ ਮੁੜ-ਸਟੋਰ ਕਰੋ ।

ਅੰਤਮ ਬਿੰਦੂ 4
ਬੇਸ ਪਾਥ /api/v1/backups
ਪ੍ਰਾਪਤ ਕਰੋ /api/v1/backups/

ਸਾਰੇ ਬੈਕਅੱਪਾਂ ਦੀ ਸੂਚੀ ਬਣਾਓ

ਤੁਹਾਡੇ ਸਭ ਸਰਵਰਾਂ ਦੇ ਬੈਕਅੱਪ ਮੁੜ- ਪ੍ਰਾਪਤ ਕਰੋ, ਨਵਾਂ ਪਹਿਲਾਂ, ਪ੍ਰਤੀ ਸਫ਼ਾ ੨੫ । ਕੋਈ ਸਰਵਰ ਫਿਲਟਰ ਨਹੀਂ ਹੈ: ਉਨ੍ਹਾਂ ਨੂੰ ਗਰੁੱਪ ਕਰਨ ਲਈ server_ hostname ਵਰਤੋਂ ।

ਲੋੜੀਦੇ ਅਧਿਕਾਰ: backups:list

ਪੁੱਛਗਿੱਛ ਪੈਰਾਮੀਟਰ

ਪੈਰਾਮੀਟਰ ਦੀ ਕਿਸਮ ਲੋੜੀਂਦਾ ਵੇਰਵਾ
page integer ਕੋਈ ਨਹੀਂ ਪੇਜ਼ ਨੰਬਰ, 1 ਤੋਂ ਸ਼ੁਰੂ

ਉਦਾਹਰਨ ਬੇਨਤੀ

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/backups/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

url = "https://admin.vps.org/api/v1/backups/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.get(url, headers=headers)
for backup in response.json()["results"]:
    print(backup["id"], backup["server_hostname"], backup["created_at"])
const response = await fetch('https://admin.vps.org/api/v1/backups/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

const data = await response.json();
console.log(data.results);

ਉਦਾਹਰਨ ਜਵਾਬ

{
  "count": 96,
  "next": "https://admin.vps.org/api/v1/backups/?page=2",
  "previous": null,
  "results": [
    {
      "id": 5512,
      "server_hostname": "web-01",
      "name": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
      "size_gb": 3.12,
      "deletion_date": "2026-09-21T20:45:40.697512Z",
      "days_remaining": 6,
      "created_at": "2026-09-14T20:45:40.699494Z"
    }
  ]
}

ਜਵਾਬ ਖੇਤਰ

ਖੇਤਰ ਦੀ ਕਿਸਮ ਵੇਰਵਾ
id integer ਬੈਕਅੱਪ ਪਛਾਣ, get ਅਤੇ restore ਅੰਤ- ਬਿੰਦੂਆਂ ਲਈ ਵਰਤੀ ਜਾਂਦੀ ਹੈ
server_hostname string ਬੈਕਅੱਪ ਲਈ ਸਰਵਰ ਦਾ ਹੋਸਟ- ਨਾਂ
name string ਬੈਕਅੱਪ ਅਕਾਇਵ ਫਾਇਲ ਨਾਂ
size_gb number ਕੰਪਰੈੱਸ ਸਾਈਜ਼ ਗਾਈਬਾਇਟ ਵਿੱਚ
deletion_date datetime ਜਦੋਂ ਬੈਕਅੱਪ ਆਟੋਮੈਟਿਕ ਹੀ ਹਟਾ ਦਿੱਤਾ ਜਾਵੇਗਾ
days_remaining integer ਹਟਾਉਣ ਮਿਤੀ ਤੱਕ ਪੂਰੇ ਦਿਨ ਬਾਕੀ ਹਨ
created_at datetime ਬਣਾਉਣ ਸਮਾਂ (ISO 8601, UTC)

ਜਵਾਬ ਸਥਿਤੀ ਕੋਡ

200 ਬੈਕਅੱਪ ਲਿਸਟ ਸਫਲਤਾਪੂਰਕ ਪ੍ਰਾਪਤ ਕੀਤੀ
403 ਗੁੰਮ ਜਾਂ ਅਢੁੱਕਵਾਂ API ਟੋਕਨ ਹੈ, ਜਾਂ ਟੋਕਨ ਵਿੱਚ ਲੋੜੀਦੇ ਅਧਿਕਾਰ ਨਹੀਂ ਹਨ
ਪ੍ਰਾਪਤ ਕਰੋ /api/v1/backups/{id}/

ਬੈਕਅੱਪ ਲਵੋ

ਇੱਕ ਬੈਕਅੱਪ ਇਕਾਈ ਉੱਤੇ ਖੇਤਰਾਂ ਨਾਲ ਮੁੜ- ਪ੍ਰਾਪਤ ਕਰੋ ।

curl -X GET "https://admin.vps.org/api/v1/backups/5512/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
ਪੋਸਟ /api/v1/servers/{uuid}/backup/

ਬੈਕਅੱਪ ਬਣਾਓ

ਇੱਕ ਡਿਪੋਜ਼ਿਟ ਸਰਵਰ ਦਾ ਬੈਕਅੱਪ ਕਤਾਰ ਵਿੱਚ ਰੱਖੋ । ਕੋਈ ਮੰਗ ਭਾਗ ਲੋੜੀਦਾ ਨਹੀਂ ਹੈ । ਬੈਕਅੱਪ ਲਿਸਟ ਵਿੱਚ ਵੇਖਾਇਆ ਜਾਵੇਗਾ, ਜਦੋਂ ਇਹ ਮੁਕੰਮਲ ਹੋ ਜਾਵੇ, ਜੋ ਕਿ ਡਿਸਕ ਵਰਤੋਂ ਉੱਤੇ ਨਿਰਭਰ ਕਰਕੇ ਕਈ ਮਿੰਟ ਲੈ ਸਕਦਾ ਹੈ ।

ਲੋੜੀਦੇ ਅਧਿਕਾਰ: servers:backup

cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/backup/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
import requests

server_uuid = "8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b"
url = f"https://admin.vps.org/api/v1/servers/{server_uuid}/backup/"
headers = {"Authorization": "Bearer YOUR_API_TOKEN"}

response = requests.post(url, headers=headers)
print(response.json())

ਉਦਾਹਰਨ ਜਵਾਬ

{
  "message": "Backup queued successfully"
}

ਜਵਾਬ ਸਥਿਤੀ ਕੋਡ

200 ਐਕਸ਼ਨ ਕਤਾਰ ਵਿੱਚ ਹੈ
400 ਸਰਵਰ ਹਾਲੇ ਡਿਪੋਜ਼ਿਟ ਨਹੀਂ ਕੀਤਾ ਗਿਆ ਹੈ
402 ਫਾਇਲ ਉੱਤੇ ਕੋਈ ਭੁਗਤਾਨ ਢੰਗ ਨਹੀਂ ਹੈ, ਜਾਂ ਨਾ- ਭੁਗਤਾਨ ਕੀਤੇ ਬਿੱਲ
404 ਨਹੀਂ ਲੱਭਿਆ ਜਾਂ ਇਹ ਹੋਰ ਅਕਾਊਂਟ ਨਾਲ ਸਬੰਧਤ ਹੈ
ਪੋਸਟ /api/v1/backups/{id}/restore/

ਬੈਕਅੱਪ ਤੋਂ ਸਰਵਰ ਰੀ- ਸਟੋਰ ਕਰੋ

ਸਰਵਰ, ਜਿਸ ਤੋਂ ਬੈਕਅੱਪ ਲਿਆ ਗਿਆ ਸੀ, ਨੂੰ ਰੋਕੋ, ਬੈਕਅੱਪ ਨਾਲ ਡਿਸਕ ਉੱਤੇ ਲਿਖੋ ਅਤੇ ਮੁੜ ਸ਼ੁਰੂ ਕਰੋ । ਕੋਈ ਮੰਗ ਭਾਗ ਲੋੜੀਦਾ ਨਹੀਂ ਹੈ । ਜਦੋਂ ਰੀ- ਸਟੋਰ ਚੱਲ ਰਿਹਾ ਹੋਵੇ ਤਾਂ ਸਰਵਰ ਦੀ ਹਾਲਤ ਕਤਾਰ ਵਿੱਚ ਹੈ ।

ਲੋੜੀਦੇ ਅਧਿਕਾਰ: backups:restore

curl -X POST "https://admin.vps.org/api/v1/backups/5512/restore/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Backup restore queued. The server will be stopped, restored, and restarted.",
  "backup": "vzdump-qemu-1042-2026_09_14-16_44_10.vma.zst",
  "job_id": "b6f1c7e2-3a4d-4f5e-8b9c-0d1e2f3a4b5c"
}
ਚੇਤਾਵਨੀ: ਬੈਕਅੱਪ ਲੈਣ ਤੋਂ ਬਾਅਦ ਸਰਵਰ ਉੱਤੇ ਲਿਖਿਆ ਸਭ ਕੁਝ ਗੁੰਮ ਹੋ ਜਾਂਦਾ ਹੈ । ਰੀ- ਸਟੋਰਿੰਗ ਵਾਪਸ ਨਹੀਂ ਕੀਤੀ ਜਾ ਸਕਦੀ ਹੈ ।

ਜਵਾਬ ਸਥਿਤੀ ਕੋਡ

200 ਐਕਸ਼ਨ ਕਤਾਰ ਵਿੱਚ ਹੈ
400 ਸਰਵਰ ਹਾਲੇ ਡਿਪੋਜ਼ਿਟ ਨਹੀਂ ਕੀਤਾ ਗਿਆ ਹੈ
404 ਨਹੀਂ ਲੱਭਿਆ ਜਾਂ ਇਹ ਹੋਰ ਅਕਾਊਂਟ ਨਾਲ ਸਬੰਧਤ ਹੈ

ਨੋਟਿਸ