Rhestru Pob Ciplun
Adalw rhestr o'r holl cipluniau ar draws eich gweinyddion.
Paramedrau'r Ymholiad
Paramedr
Math
Angenrheidiol
Disgrifiad
server_id
integer
Na
Hidlo cipluniau yn ôl ID gweinydd
Cais Enghraifft
curl -X GET "https://admin.vps.org/api/v1/snapshots/?server_id=12345" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json"
Copy
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())
Copy
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);
Copy
Ymateb Enghraifft
{
"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"
}
]
}
Codau Statws Ymateb
200
Adalwyd rhestr cipluniau yn llwyddiannus
401
Heb awdurdod - Tocyn dilysu annilys neu ar goll
Creu Ciplun
Create a snapshot of a server's current state. Snapshots are point-in-time copies of the entire server.
Paramedrau Corff y Cais
Paramedr
Math
Angenrheidiol
Disgrifiad
server_id
integer
Ie
ID y gweinydd i'w dynnu
name
string
Ie
Enw ar gyfer y ciplun (alffaniwmerig, cysylltnodau, tanlinellau)
description
string
Na
Disgrifiad dewisol ar gyfer y ciplun
Cais Enghraifft
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"
}'
Copy
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())
Copy
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);
Copy
Ymateb Enghraifft
{
"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."
}
Codau Statws Ymateb
201
Cychwynnwyd creu ciplun yn llwyddiannus
400
Bad Request - Invalid parameters or snapshot limit reached
401
Heb awdurdod - Tocyn dilysu annilys neu ar goll
404
Not Found - Server does not exist
Nodyn: 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.
Adfer o'r Ciplun
Restore a server to the state captured in a snapshot. This will overwrite all current data on the server.
Paramedrau Llwybr
Paramedr
Math
Angenrheidiol
Disgrifiad
snapshot_id
integer
Ie
ID ciplun unigryw
Cais Enghraifft
curl -X POST "https://admin.vps.org/api/v1/snapshots/801/restore/" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json"
Copy
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())
Copy
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);
Copy
Ymateb Enghraifft
{
"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"
}
}
Codau Statws Ymateb
200
Cychwynnwyd yr adferiad yn llwyddiannus
400
Bad Request - Server is not in a valid state for restoration
401
Heb awdurdod - Tocyn dilysu annilys neu ar goll
404
Heb ei Ganfod - Nid yw'r ciplun yn bodoli
Rhybudd: 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.
Dileu Ciplun
Dileu ciplun yn barhaol. Ni ellir dadwneud y weithred hon.
Paramedrau Llwybr
Paramedr
Math
Angenrheidiol
Disgrifiad
snapshot_id
integer
Ie
ID ciplun unigryw
Cais Enghraifft
curl -X DELETE "https://admin.vps.org/api/v1/snapshots/801/" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json"
Copy
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)
Copy
Codau Statws Ymateb
204
Ciplun wedi'i ddileu'n llwyddiannus
401
Heb awdurdod - Tocyn dilysu annilys neu ar goll
404
Heb ei Ganfod - Nid yw'r ciplun yn bodoli
Snapshots vs Backups
Understanding when to use snapshots versus backups:
API Cipluniau
Diben: Quick point-in-time recovery
Cyflymder: Faster to create and restore (3-15 min)
Achos Defnydd: Before risky operations (updates, config changes)
Storio: Stored on same infrastructure
Terfyn: 5 snapshots per server
Gorau Ar Gyfer: Short-term rollback capability
API Copïau Wrth Gefn
Diben: Long-term data protection
Cyflymder: Slower to create and restore (varies)
Achos Defnydd: Regular automated data protection
Storio: Separate backup storage
Terfyn: 10 manual + automatic backups
Gorau Ar Gyfer: Disaster recovery and compliance
Best Practices
Before Updates: Create a snapshot before major system updates
Testing: Use snapshots when testing configuration changes
Combined Strategy: Use both snapshots (short-term) and backups (long-term)
Clean Up: Delete old snapshots after successful updates
Server State: Consider stopping the server before creating critical snapshots