VPS.org API

REST API Documentation

API-ja e pamjeve të çastit

Menaxhoni pamjet e serverit për një rivendosje të shpejtë në çdo moment. Pamjet e çastit kapin gjendjen e plotë të serverit tuaj.

Pikat fundore 4 endpoints
Shtegu Bazë /api/v1/snapshots
MERR /api/v1/snapshots/

Listo të gjitha pamjet e çastit

Merrni një listë të të gjitha pamjeve të çastit në të gjithë serverët tuaj.

Parametrat e pyetjes

Parameter Lloji E detyrueshme Description
server_id integer No Filtro pamjet e çastit sipas ID-së së serverit

Shembull Kërkese

cURL
Python
JavaScript
curl -X GET "https://admin.vps.org/api/v1/snapshots/?server_id=12345" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

url = "https://admin.vps.org/api/v1/snapshots/"
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/snapshots/?server_id=12345', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const snapshots = await response.json();
console.log(snapshots);

Shembull Përgjigjeje

{
  "count": 2,
  "results": [
    {
      "id": 801,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "name": "pre-migration-snapshot",
      "status": "completed",
      "size_mb": 5120,
      "created_at": "2025-01-15T18:30:00Z",
      "description": "Before major migration"
    },
    {
      "id": 798,
      "server": {
        "id": 12345,
        "name": "web-server-01"
      },
      "name": "weekly-snapshot-2025-01-08",
      "status": "completed",
      "size_mb": 4856,
      "created_at": "2025-01-08T12:00:00Z",
      "description": "Weekly snapshot"
    }
  ]
}

Kodet e Statusit të Përgjigjes

200 Lista e pamjeve të çastit u mor me sukses
401 I paautorizuar - Token vërtetimi i pavlefshëm ose mungon
POST /api/v1/snapshots/

Krijo një pamje të çastit

Create a snapshot of a server's current state. Snapshots are point-in-time copies of the entire server.

Parametrat e Trupit të Kërkesës

Parameter Lloji E detyrueshme Description
server_id integer Po ID-ja e serverit për të marrë pamjen e çastit
name string Po Emri për pamjen e çastit (alfanumerik, viza lidhëse, nënvizime)
description string No Përshkrim opsional për pamjen e çastit

Shembull Kërkese

cURL
Python
JavaScript
curl -X POST "https://admin.vps.org/api/v1/snapshots/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "server_id": 12345,
    "name": "before-update-snapshot",
    "description": "Snapshot before system update"
  }'
import requests

url = "https://admin.vps.org/api/v1/snapshots/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}
data = {
    "server_id": 12345,
    "name": "before-update-snapshot",
    "description": "Snapshot before system update"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch('https://admin.vps.org/api/v1/snapshots/', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    server_id: 12345,
    name: 'before-update-snapshot',
    description: 'Snapshot before system update'
  })
});

const snapshot = await response.json();
console.log(snapshot);

Shembull Përgjigjeje

{
  "id": 802,
  "server": {
    "id": 12345,
    "name": "web-server-01"
  },
  "name": "before-update-snapshot",
  "status": "in_progress",
  "size_mb": null,
  "created_at": "2025-01-16T16:15:00Z",
  "description": "Snapshot before system update",
  "message": "Snapshot is being created. This may take 3-10 minutes depending on server size."
}

Kodet e Statusit të Përgjigjes

201 Krijimi i një pamjeje të çastit filloi me sukses
400 Bad Request - Invalid parameters or snapshot limit reached
401 I paautorizuar - Token vërtetimi i pavlefshëm ose mungon
404 Not Found - Server does not exist
Note: You can have a maximum of 5 snapshots per server. Creating a snapshot while the server is running may result in filesystem inconsistencies. For best results, stop the server before creating a snapshot.
POST /api/v1/snapshots/{snapshot_id}/restore/

Rivendos nga një pamje e çastit

Restore a server to the state captured in a snapshot. This will overwrite all current data on the server.

Parametrat e Shtegut

Parameter Lloji E detyrueshme Description
snapshot_id integer Po ID unike e çastit të ngjarjes

Shembull Kërkese

cURL
Python
JavaScript
curl -X POST "https://admin.vps.org/api/v1/snapshots/801/restore/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

snapshot_id = 801
url = f"https://admin.vps.org/api/v1/snapshots/{snapshot_id}/restore/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.post(url, headers=headers)
print(response.json())
const snapshotId = 801;
const response = await fetch(`https://admin.vps.org/api/v1/snapshots/${snapshotId}/restore/`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  }
});

const result = await response.json();
console.log(result);

Shembull Përgjigjeje

{
  "status": "success",
  "message": "Server is being restored from snapshot. This may take 5-15 minutes.",
  "snapshot": {
    "id": 801,
    "name": "pre-migration-snapshot",
    "created_at": "2025-01-15T18:30:00Z"
  },
  "server": {
    "id": 12345,
    "name": "web-server-01",
    "status": "restoring"
  }
}

Kodet e Statusit të Përgjigjes

200 Rivendosja filloi me sukses
400 Bad Request - Server is not in a valid state for restoration
401 I paautorizuar - Token vërtetimi i pavlefshëm ose mungon
404 Nuk u gjet - Pamja e çastit nuk ekziston
Paralajmërim: Restoring from a snapshot will overwrite all current data on the server. This action cannot be undone. The server will be automatically stopped before restoration begins.
FSHIR /api/v1/snapshots/{snapshot_id}/

Fshij Pamjen e Çastit

Fshi përgjithmonë një pamje të çastit. Ky veprim nuk mund të zhbëhet.

Parametrat e Shtegut

Parameter Lloji E detyrueshme Description
snapshot_id integer Po ID unike e çastit të ngjarjes

Shembull Kërkese

cURL
Python
curl -X DELETE "https://admin.vps.org/api/v1/snapshots/801/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"
import requests

snapshot_id = 801
url = f"https://admin.vps.org/api/v1/snapshots/{snapshot_id}/"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}

response = requests.delete(url, headers=headers)
print(response.status_code)

Kodet e Statusit të Përgjigjes

204 Pamja e çastit u fshi me sukses
401 I paautorizuar - Token vërtetimi i pavlefshëm ose mungon
404 Nuk u gjet - Pamja e çastit nuk ekziston

Snapshots vs Backups

Understanding when to use snapshots versus backups:

API-ja e pamjeve të çastit

  • Qëllimi: Quick point-in-time recovery
  • Shpejtësia: Faster to create and restore (3-15 min)
  • Rasti i përdorimit: Before risky operations (updates, config changes)
  • Magazinimi: Stored on same infrastructure
  • Limit: 5 snapshots per server
  • Më e mira për: Short-term rollback capability

API-ja e kopjeve rezervë

  • Qëllimi: Long-term data protection
  • Shpejtësia: Slower to create and restore (varies)
  • Rasti i përdorimit: Regular automated data protection
  • Magazinimi: Separate backup storage
  • Limit: 10 manual + automatic backups
  • Më e mira për: Disaster recovery and compliance

Best Practices