VPS.org API

REST API -dokumentaatio

Varmuuskopioiden API

Luettele palvelimen varmuuskopiot, käynnistä uusi varmuuskopio ja palauta palvelimen yhdestä.

Päätepisteet 4
Perusreitti /api/v1/backups
SAADA /api/v1/backups/

Listaa kaikki varmuuskopiot

Palauttaa kaikkien palvelimien varmuuskopiot, uusin ensin, 25 sivulla. Palvelinsuodatinta ei ole: käytä palvelinta_hostnamea ryhmitelläksesi ne.

Vaadittu lupa: backups:list

Kyselyparametrit

Muuttuja Tyyppi Pakollinen Tavaran kuvaus
page integer Ei tarvitse. Page number, starting at 1

Esimerkkipyyntö

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

Esimerkkivastaus

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

Vastauskentät

Kenttä Tyyppi Tavaran kuvaus
id integer Varmuuskopiointitunniste, jota käytetään get- ja restaurointikohteissa
server_hostname string Palvelimen nimi, jolta varmuuskopio otettiin
name string Varmuuskopion arkiston nimi
size_gb number Puristettu koko gigatavuina
deletion_date datetime Kun varmuuskopio poistetaan automaattisesti
days_remaining integer Kokonaiset päivät jäljellä poistopäivään asti
created_at datetime Luontiaika (ISO 8601, UTC)

Vastauksen tilakoodit

200 Onnistunut varmuuskopiointilista
403 Puuttuva tai virheellinen API-tunnus tai postimerkki puuttuu vaaditusta luvasta
SAADA /api/v1/backups/{id}/

Hanki apujoukkoja

Palauttaa yhden varmuuskopion yllä olevilla kentillä.

curl -X GET "https://admin.vps.org/api/v1/backups/5512/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
JÄLKEEN /api/v1/servers/{uuid}/backup/

Luo varmuuskopio

Varaa käyttöönotetun palvelimen varmuuskopion. Pyyntöelintä ei tarvita. Varaus on listassa sen valmistuttua, mikä voi kestää useita minuutteja levynkäytöstä riippuen.

Vaadittu lupa: 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())

Esimerkkivastaus

{
  "message": "Backup queued successfully"
}

Vastauksen tilakoodit

200 Toimintaa jonotettiin
400 Palvelinta ei ole vielä käytössä
402 Ei maksutapaa tiedostossa tai maksamattomia laskuja
404 Ei löytynyt, tai se kuuluu toiselle tilille
JÄLKEEN /api/v1/backups/{id}/restore/

Palauta palvelin varmuuskopiosta

Pysäyttää palvelimen, jolta varmuuskopio otettiin, korvaa levyn varmuuskopiolla ja käynnistää sen uudelleen. Pyyntöelintä ei tarvita. Palvelimen tila on jonossa, kun palautus tapahtuu.

Vaadittu lupa: 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"
}
Varoitus: Kaikki palvelimelle taustatuen ottamisen jälkeen kirjoitettu on menetetty. Palautus ei voi perua.

Vastauksen tilakoodit

200 Toimintaa jonotettiin
400 Palvelinta ei ole vielä käytössä
404 Ei löytynyt, tai se kuuluu toiselle tilille

Huomautuksia