VPS.org API

Documentazione REST API

API di snapshots

Facci istantanee di un servituri, listalli e canciari chiḍḍi ca nun ti servinu cchiù.

Punti finali 4
Percorsu di Base /api/v1/snapshots
OTTIENI /api/v1/snapshots/

Elencu di tutte l'istantanee

Ritorna l'istantanei di u vostru contu, prima u cchiù novu, 25 per pagina.

Permessi richiesti: snapshots:list

Esempiu di dumanda

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

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

response = requests.get(url, headers=headers)
for snapshot in response.json()["results"]:
    print(snapshot["uuid"], snapshot["label"], snapshot["ready"])
const response = await fetch('https://admin.vps.org/api/v1/snapshots/', {
  headers: { 'Authorization': 'Bearer YOUR_API_TOKEN' }
});

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

Esempiu di risposta

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b",
      "label": "before-upgrade",
      "server_hostname": "web-01",
      "ready": true,
      "deleting": false,
      "created_at": "2026-09-14T18:30:00.000000Z",
      "size_gb": 3.4
    }
  ]
}

Campi di risposta

Campu Tipu Descrizzioni
uuid string Identificativu di l'istantanea (32 caratteri esadecimali, senza trattini)
label string Etichetta data quannu l'istantanea fu criata
server_hostname string U nomu di l'òspiti dû servituri di unni fu pigghiata l'istantanea, o null si stu servituri nun esisti cchiù
ready boolean Veru quannu l'istantanea è finita
deleting boolean Vera mentri una cancellazzioni è in corso
created_at datetime Ora di criazzioni (ISO 8601, UTC)
size_gb number Dimensioni cumpressione in gigabytes
OTTIENI /api/v1/snapshots/{uuid}/

Facci n'istantanea

Ritorna un oggettu di l'istantanea cu li campi di supra. Usallu pi scantà dopu a criazzioni di n'istantanea.

curl -X GET "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
POST /api/v1/servers/{uuid}/snapshot/

Crea n'istantanea

Metti in coda n'istantanea di nu servituri spartutu e riturna l'uuid dâ nova istantanee. L'istantanea è elencata immediatamenti cu ready impostatu a false.

Permessi richiesti: servers:snapshot

Parametri di u Corpu di a Richiesta

Parametri Tipu Obbligatoriu Descrizzioni
action string Iè Devi èssiri n'istantanea
snapshot_label string Iè N'etichetta pi ricanùsciri l'istantanea
cURL
Python
curl -X POST "https://admin.vps.org/api/v1/servers/8c4f2a1e-5b3d-4e6f-9a7b-1c2d3e4f5a6b/snapshot/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action": "snapshot", "snapshot_label": "before-upgrade"}'
import requests

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

response = requests.post(url, headers=headers, json=data)
print(response.json()["snapshot_uuid"])

Esempiu di risposta

{
  "message": "Snapshot queued successfully",
  "snapshot_uuid": "3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b"
}

Codici di Statu di Risposta

200 L'azzioni fu messa 'n coda
400 mancanu l'azione o l'etichetta di l'istantanea, o u servituri nun è ancora dispiegatu
402 Nudda manera di pagà in archiviu, o fatture non pagate
404 Non truvatu, o appartiene a un altru contu
SCANCÀ /api/v1/snapshots/{uuid}/

Eliminari n'istantanea

Metti in coda l'istantanea pi cancellallu definitivamenti. Eliminari è veru finu a chi s'hè sparitu.

Permessi richiesti: snapshots:delete

curl -X DELETE "https://admin.vps.org/api/v1/snapshots/3f9a1c0e5b7d4e2f8a6c1b3d5e7f9a0b/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "message": "Snapshot deletion queued"
}

Codici di Statu di Risposta

202 Accettatu: la richiesta fu messa in coda
404 Non truvatu, o appartiene a un altru contu

Note